Skip to main content

CLI

Use the SocQ CLI for terminal workflows, automation, and exporting normalized task results as JSON, JSONL, CSV, or tables.
The @socq/cli package is not yet available on the public npm registry. The commands below document the upcoming package and can be used from the SocQ devtools repository during development.

Install and authenticate

After the package is published:
For CI, set SOCQ_API_KEY instead of using interactive login. Avoid --api-key in normal terminal use because command arguments may remain in shell history or process listings.

Discover endpoints

Use describe before building automation so the command uses the current input schema and billing information from the Capability Registry.

Complete your first collection

The dynamic command maps directly to:
Use the stable generic form when inputs come from a file:

Resume without resubmitting

If a command returns before the collection finishes, keep the task ID:
Do not submit the original collection again just because a local wait timed out. Resume the existing task.

Output formats