CLI reference

The terminal shell over the gateway and Build surfaces, generated from the CLI help.

The commands below are a thin shell over the REST routes. get prints the document and nothing else, so it pipes; every other command prints text, or {"data": …} / {"error": …} with --json.

spinrun help

Spinrun — one gateway for every tool your agent can reach.

Usage
  spinrun login                        authorize in your browser
  spinrun logout                       forget the stored authorization
  spinrun status                       who you are and which workspace

  spinrun search <query>               find a tool by describing the job
  spinrun execute <TOOL> -d '<json>'   run one, with arguments
  spinrun tools                        list every tool you can reach

  spinrun apps                         connected apps in this workspace
  spinrun connect <toolkit>            open the browser to connect one
  spinrun logs [-n 20] [-f]            your recent tool calls

  spinrun install <client> [--build]   write the gateway into a client's config
  spinrun gateway <client> [--build]   print the install steps instead

Build — author agents and workflows as JSON documents
  spinrun agent list                   agents this token may author
  spinrun agent get <ref>              print one as JSON (id or slug)
  spinrun agent validate [--file f]    check a document without saving it
  spinrun agent put [--file f]         create, or replace when it has updated_at
  spinrun agent test <ref> [--prompt p] run it once and wait for the result
  spinrun agent delete <ref>           archive it (--force also removes webhooks)
  spinrun workflow list|get|validate|put|test|delete   the same, for workflows
  spinrun connections                  connections a document may name
  spinrun catalog                      models, apps, trigger types and limits

Options
  -d, --data <json>     arguments for execute; use "-" to read stdin
      --data-file <p>   arguments from a file
      --file <p>        a document for validate/put (default: stdin)
      --prompt <text>   the prompt for agent test
      --force           put/delete: allow webhook triggers to be removed
      --json            print {"data": …} or {"error": …} instead of text
  -n, --limit <n>       how many rows (logs, search)
  -f, --follow          keep polling for new activity
      --config-path <p> override where install writes
      --with-key <key>  install with an API key instead of browser auth
      --build           install/gateway: the Build endpoint (OAuth only)
      --refresh         ignore the cached tool list
  -h, --help            this text
  -v, --version         version

Exit codes: 0 ok · 1 this program or the network · 2 the server refused

Clients: claude-code, codex, cursor, vscode, windsurf, gemini-cli
Gateway: https://spinrun.ai/mcp
Build:   https://spinrun.ai/mcp/build

Related

On this page