Skip to Content
supedocs

CLI

Every supe command and flag.

npm i -g @supe-sh/cli    # Node 18 or later

The CLI never waits for input. Output is JSON when it isn't writing to a terminal, or with --json. Every command ends with an exit code.

Tools

CommandWhat it does
supe find [words]Search tools. --tag, --provider, --max-price, --limit filter. Alone, lists every tag.
supe inspect <tool_id|tag>A tool's parameters by part, price and alternatives; or a tag's tools
supe run <tool_id> …Run one tool. supe <tool_id> … does the same.
supe job <job_id>Collect a long job
supe upload <file|link>Store a local file, or a copy of a link, and print its link
supe upload --link <name>A one-time page for a person to upload a file through
supe files [name]Files in this workspace, with their links

Recipes

CommandWhat it does
supe recipes [words]Search the Cookbook and yours; with no words, list yours
supe recipe <id> [--tier t]Its inputs and steps
supe recipe save <id>Copy a Cookbook recipe into your workspace
supe recipe save -f <file>Write one from JSON: name, description, inputs, steps

Money

CommandWhat it does
supe balanceThe wallet, in credits
supe budget <credits>Open a run with a spending cap; bill calls to it with SUPE_RUN
supe runsRecent runs
supe receipt <run_id>What a run spent, step by step
supe approve <tool> --reason "…"Ask a person to turn a tool on; --amount asks for more budget
supe rentalsPhone numbers and inboxes this workspace rents
supe rentals release <id>Stop renewing one. It can't be undone, so it asks first (exit 3).

Account

CommandWhat it does
supe login --email <email> [--name <name>]Start signing in this machine as an agent; prints a link for your user
supe login --code <code>Finish signing in with the code the page shows
supe logoutRevoke this agent and forget it here
supe whoamiThe workspace, this agent and what it spent today
supe agentsAgents signed in on this machine
supe skill [--save <dir>]Print the agent instructions; --save writes <dir>/supe/SKILL.md

Run options

FlagWhat it does
--path name=valueA path parameter. Repeat for each.
--query name=valueA query parameter
--body name=valueA body parameter. a.b=1 nests as {"a":{"b":1}}.
--input <json|->, -f <file>The whole input as {"path":…,"query":…,"body":…}; the flags above add to it
--max-price <credits>Refuse the call if it costs more
--budget <credits>Cap the run this call opens
--run <id>Bill an open run (or set SUPE_RUN)
--goal <text>What the run is for, shown on its receipt
--confirm <id>Go ahead with a call that asked first
--no-waitReturn a long job's id instead of waiting
-o <file>Write the result to a file
--fullThe whole answer (cost, run, receipt), not just the provider's response

Everywhere

Flag or variableWhat it does
--jsonJSON on stdout (the default without a terminal)
--agent <name>, SUPE_AGENTAct as this signed-in agent
SUPE_API_KEYUse a dashboard key instead of a signed-in agent, as in CI
--base-url <url>, SUPE_BASE_URLAnother server
SUPE_CONFIG_DIRWhere sign-ins are kept
--help, --version

On this page