SimetrikDocs
ReferenceSources & data

file

Subcommands of simetrik file.

simetrik file sign

Generate presigned S3 URLs for file upload.

Generates presigned S3 URLs so you can upload file bytes directly to storage. This is step 1 of the low-level manual upload flow: sign → PUT the bytes to the returned URL yourself → register the file with simetrik file create.

Pass --files as a JSON dict mapping a path id to {"name": "...", "type": "..."}. Most users don't need this — simetrik file upload performs the sign, upload, and register in one step. Reach for file sign only when you control the S3 PUT yourself (custom tooling, large pipelines).

Requires the resources · create_edit permission. See permissions.

Flags

  • -s, --source <id> — Source ID
  • --files <json> — JSON dict: {"path_id": {"name": "data.csv", "type": "text/csv"}}
  • -f, --format <fmt> — Output format: json|table

Examples

simetrik file sign --source src_abc123 --files '{"f1":{"name":"data.csv","type":"text/csv"}}'

Exit codes

CodeMeaning
0Presigned URLs returned
2Invalid input — unknown --source or malformed --files JSON
4Authentication required — run simetrik login

simetrik file create

Create a file management record after S3 upload.

Registers a file-management record after you've uploaded the bytes to S3 — the final step of the low-level manual flow that starts with simetrik file sign. It records the file's name, path, and size against the source so Simetrik knows the upload exists.

Pair it with file sign; most users skip both and use simetrik file upload, which signs, uploads, and registers in one command. Add --run-reconcile to trigger reconciliation once the record is created.

Requires the resources · create_edit permission. See permissions.

Flags

  • -s, --source <id> — Source ID
  • --filename <name> — File name
  • --pathfile <path> — File path
  • --size <bytes> — File size in bytes
  • --run-reconcile — Trigger reconciliation after upload
  • -f, --format <fmt> — Output format: json|table

Examples

simetrik file create --source src_abc123 --filename data.csv --pathfile uploads/data.csv --size 20480
simetrik file create --source src_abc123 --filename data.csv --pathfile uploads/data.csv --size 20480 --run-reconcile

Exit codes

CodeMeaning
0File record created
2Invalid input — unknown --source or missing file metadata
4Authentication required — run simetrik login

simetrik file list

List files for a source.

Lists the files registered against a source, with their IDs and status. Use it to confirm an upload landed, or to find a file's ID before changing its status with simetrik file status.

Requires CLI access to the workspace. See permissions.

Flags

  • -s, --source <id> — Source ID
  • -f, --format <fmt> — Output format: table|json

Examples

simetrik file list --source src_abc123
simetrik file list --source src_abc123 --format json

simetrik file status

Update file status.

Updates the status of a file record. Pass the file_id and the new value with --status. Look up a file's ID first with simetrik file list.

Requires the resources · create_edit permission. See permissions.

Arguments

  • file_id — File ID

Flags

  • --status <status> — New status
  • -f, --format <fmt> — Output format: json|table

Examples

simetrik file status file_abc123 --status active

Exit codes

CodeMeaning
0File status updated
2Invalid input — unknown file_id or invalid --status value
4Authentication required — run simetrik login

simetrik file upload

Upload one or more files to a source.

Uploads one or more files to a source in a single command — it presigns, pushes the bytes to S3, and registers each file for you. This is the recommended way to load data into a source; it rolls up what the low-level file sign and file create do by hand.

Tune throughput with --concurrency (1–10 simultaneous uploads). By default it's best-effort and keeps going if one file fails; pass --fail-fast to abort on the first error instead. Content type is auto-detected from the extension unless you override it with --type. Add --run-reconcile to trigger reconciliation after the last file lands.

To see what's already been uploaded, use simetrik file list.

Requires the resources · create_edit permission. See permissions.

Arguments

  • files

Flags

  • -s, --source <id> — Source ID
  • --run-reconcile — Trigger reconciliation after upload (last file)
  • --type <mime> — Override Content-Type (auto-detected by extension if omitted)
  • --concurrency <n> — Max simultaneous S3 PUTs (1-10)
  • --fail-fast — Abort on first failure instead of continuing best-effort
  • -f, --format <fmt> — Output format: json|table

Examples

simetrik file upload ventas.csv --source src_abc123
simetrik file upload enero.csv febrero.csv marzo.csv --source src_abc123 --concurrency 5
simetrik file upload data.csv --source src_abc123 --run-reconcile

Exit codes

CodeMeaning
0All files uploaded and registered
2Invalid input — file not found, unknown --source, or bad --concurrency
4Authentication required — run simetrik login

On this page