These commands manage files and their metadata through the REST API and Upload API.
Global flags like --json, --jq, -v, and --quiet are available on every command.
See Configuration for the full list.
List files in the current project.
Flags:
JSON fields: uuid, size, filename, mime_type, is_image, is_stored, is_ready, datetime_uploaded, datetime_stored, datetime_removed, original_file_url, metadata, appdata
Examples:
Get details for a single file.
Flags:
JSON fields: uuid, size, filename, mime_type, is_image, is_stored, is_ready, datetime_uploaded, datetime_stored, datetime_removed, original_file_url, metadata, appdata
Examples:
Upload files from your local filesystem.
Files smaller than 10 MB use direct upload; larger files use multipart upload automatically.
Flags:
JSON fields: uuid, size, filename, mime_type, is_image, is_stored, is_ready, datetime_uploaded, original_file_url, metadata
Examples:
Upload a file from a URL. The CLI polls until the upload completes.
Flags:
JSON fields: uuid, size, filename, mime_type, is_image, is_stored, is_ready, datetime_uploaded, original_file_url, metadata
Examples:
Store files permanently. Accepts one or more UUIDs.
Flags:
Returns exit code 1 for partial failures. The problems field in JSON output contains per-file errors.
JSON fields: files, problems
Examples:
Delete files permanently. Accepts one or more UUIDs.
Deletion is permanent and cannot be undone. Use --dry-run to preview.
Flags:
Returns exit code 1 for partial failures.
JSON fields: files, problems
Examples:
Create a copy of a file within Uploadcare storage. The copy gets a new UUID.
Flags:
JSON fields: uuid, size, filename, mime_type, is_image, is_stored, is_ready, datetime_uploaded, original_file_url
Examples:
Download files from the Uploadcare CDN to the local filesystem.
Accepts UUIDs as positional arguments, from stdin (--from-stdin), or both. Single-UUID
mode writes to --output <path> (use - to stream to stdout), or to ./<filename> when
omitted. Batch mode (multiple UUIDs or --from-stdin) requires --output-dir and
expands --name-template per file.
Flags:
JSON fields: uuid, path, size, source_url, status (downloaded, skipped, or dry-run)
Examples:
Copy a file to an external storage target (e.g., Amazon S3). See Copy files to S3 for setup instructions.
Flags:
JSON fields: result, already_exists
Examples:
List all metadata key-value pairs for a file.
Examples:
Get a single metadata value.
Examples:
Set a metadata key-value pair.
Flags:
JSON fields: key, value (normal); key, current_value, new_value, status (dry-run)
Examples:
Delete a metadata key.
Flags:
Examples: