| title | CLI |
|---|---|
| description | Use the macrodata command line interface with Refiner |
The macrodata CLI authenticates, submits scripts, inspects jobs, follows logs,
reads metrics, and manages secrets.
Most inspection commands have a human-readable default and a --json mode for
agents, scripts, notebooks, and CI jobs. Prefer --json whenever another
program will parse the output.
macrodata jobs get job_123 --json
macrodata jobs logs job_123 --stage 0 --severity error --json
macrodata secrets list --env production --jsonlogin: Store and validate a Macrodata API key.whoami: Validate local credentials and show identity.logout: Remove local Macrodata credentials.run: Run a Macrodata Refiner pipeline script.jobs list: List jobs in the current workspace.jobs get: Get job summary.jobs attach: Attach to a running cloud job.jobs manifest: Get job manifest.jobs workers: List job workers.jobs logs: Fetch cloud job logs.jobs metrics: Fetch cloud step metrics for a stage.jobs resource-metrics: Fetch cloud resource metrics for a stage.jobs cancel: Cancel a cloud job.secrets list: List workspace secret names.secrets set: Add or replace a workspace secret.secrets remove: Remove a workspace secret.secrets delete: Alias forsecrets remove.
Use --json on commands that return structured platform data:
macrodata jobs list --jsonmacrodata jobs get <job_id> --jsonmacrodata jobs manifest <job_id> --jsonmacrodata jobs workers <job_id> --jsonmacrodata jobs logs <job_id> --jsonmacrodata jobs metrics <job_id> <stage_index> --jsonmacrodata jobs resource-metrics <job_id> <stage_index> --jsonmacrodata jobs cancel <job_id> --jsonmacrodata secrets list --jsonmacrodata secrets set <name> --value-stdin --jsonmacrodata secrets remove <name> --jsonmacrodata secrets delete <name> --json
Pagination commands return cursors in JSON responses and print a follow-up
command in human-readable mode. Use --cursor with jobs list, jobs workers,
and jobs logs.
Every command exposes its current options through --help:
macrodata --help
macrodata jobs logs --help
macrodata jobs metrics --help