Skip to content
Version: Current

Command reference

This page is generated from configured command sources. The gate compares the generated text with the checked-in page, so command source changes that affect this page fail until regeneration.

Safety note: administrative/operator commands can mutate gateway state or expose operational controls. Run them only with the intended credentials and environment. Do not copy credential values into commands, logs or docs.

Sources: acumen:cmd/acumen/main.go, cli:internal/cli/app.go, cli:internal/cli/cmds_auth.go, cli:internal/cli/cmds_studio.go, cli:internal/cli/cmds_misc.go.

Dispatcher subcommands from acumen cmd/acumen/main.go. Administrative subcommands are operator surfaces; do not expose operator credentials to end users.

Source files: acumen:cmd/acumen/main.go.

Command Aliases Defined at
acumen account provider, offer, seats, alias, key, plugin, usage, route acumen:cmd/acumen/main.go:123
acumen alias provider, account, offer, seats, key, plugin, usage, route acumen:cmd/acumen/main.go:123
acumen doctor acumen:cmd/acumen/main.go:131
acumen key provider, account, offer, seats, alias, plugin, usage, route acumen:cmd/acumen/main.go:123
acumen keyaudit acumen:cmd/acumen/main.go:129
acumen offer provider, account, seats, alias, key, plugin, usage, route acumen:cmd/acumen/main.go:123
acumen plugin provider, account, offer, seats, alias, key, usage, route acumen:cmd/acumen/main.go:123
acumen probe acumen:cmd/acumen/main.go:127
acumen provider account, offer, seats, alias, key, plugin, usage, route acumen:cmd/acumen/main.go:123
acumen route provider, account, offer, seats, alias, key, plugin, usage acumen:cmd/acumen/main.go:123
acumen seats provider, account, offer, alias, key, plugin, usage, route acumen:cmd/acumen/main.go:123
acumen studio acumen:cmd/acumen/main.go:125
acumen usage provider, account, offer, seats, alias, key, plugin, route acumen:cmd/acumen/main.go:123

Commands from the tcpsystems tcp CLI command tree. Source files are the cobra command constructors in internal/cli/*.go.

Source files: cli:internal/cli/app.go, cli:internal/cli/cmds_auth.go, cli:internal/cli/cmds_studio.go, cli:internal/cli/cmds_misc.go.

Command Use Summary Defined at
tcp login login Sign in to the tcpsystems suite cli:internal/cli/cmds_auth.go:27
Command Use Summary Defined at
tcp logout logout Sign out and delete the stored credential cli:internal/cli/cmds_auth.go:163
Command Use Summary Defined at
tcp whoami whoami Show the identity this CLI acts as cli:internal/cli/cmds_auth.go:181
Command Use Summary Defined at
tcp connections connections Inspect the account’s connections cli:internal/cli/cmds_studio.go:459
tcp connections get <connection-id> get <connection-id> Read one connection cli:internal/cli/cmds_studio.go:510
tcp connections kinds kinds List the supported connection kinds cli:internal/cli/cmds_studio.go:491
tcp connections list list List connections (name, length and fingerprint only) cli:internal/cli/cmds_studio.go:465
Command Use Summary Defined at
tcp deploy deploy Build, deploy, inspect and roll back cli:internal/cli/cmds_studio.go:594
tcp deploy get <deployment-id> get <deployment-id> Read one deployment cli:internal/cli/cmds_studio.go:642
tcp deploy list list List deployments cli:internal/cli/cmds_studio.go:620
tcp deploy logs <deployment-id> logs <deployment-id> Stream a deployment log (SSE) cli:internal/cli/cmds_studio.go:701
tcp deploy rollback <deployment-id> rollback <deployment-id> Roll back to a deployment’s artifact cli:internal/cli/cmds_studio.go:686
tcp deploy start start Build and deploy a project cli:internal/cli/cmds_studio.go:666
tcp deploy targets targets List the configured deploy targets cli:internal/cli/cmds_studio.go:600
Command Use Summary Defined at
tcp harness candidates candidates List candidate harness versions cli:internal/cli/cmds_studio.go:377
tcp harness harness Harness versions, pins and candidates cli:internal/cli/cmds_studio.go:352
tcp harness pins pins List project pins from the eve runtime cli:internal/cli/cmds_studio.go:432
tcp harness status status Show a project’s pinned harness version cli:internal/cli/cmds_studio.go:406
tcp harness versions versions List harness versions cli:internal/cli/cmds_studio.go:357
Command Use Summary Defined at
tcp keys create create Mint an API key (the secret is shown once) cli:internal/cli/cmds_studio.go:799
tcp keys keys Manage Studio API keys cli:internal/cli/cmds_studio.go:774
tcp keys list list List API keys (no secrets) cli:internal/cli/cmds_studio.go:779
tcp keys revoke <key-id> revoke <key-id> Revoke an API key cli:internal/cli/cmds_studio.go:828
Command Use Summary Defined at
tcp live live The live view of in-flight work cli:internal/cli/cmds_studio.go:302
tcp live snapshot snapshot Print the live view at one instant cli:internal/cli/cmds_studio.go:307
tcp live watch watch Stream live events (SSE) cli:internal/cli/cmds_studio.go:335
Command Use Summary Defined at
tcp preview get <preview-id> get <preview-id> Read one preview cli:internal/cli/cmds_studio.go:752
tcp preview preview Serve and inspect previews cli:internal/cli/cmds_studio.go:727
tcp preview start start Start a preview for a project cli:internal/cli/cmds_studio.go:732
Command Use Summary Defined at
tcp projects create <name> create <name> Create a project cli:internal/cli/cmds_studio.go:72
tcp projects get <project-id> get <project-id> Read one project and its repositories cli:internal/cli/cmds_studio.go:47
tcp projects list list List projects cli:internal/cli/cmds_studio.go:27
tcp projects projects Manage Studio projects cli:internal/cli/cmds_studio.go:21
Command Use Summary Defined at
tcp runs cancel <run-id> cancel <run-id> Cancel a run cli:internal/cli/cmds_studio.go:194
tcp runs get <run-id> get <run-id> Read one run with its steps cli:internal/cli/cmds_studio.go:136
tcp runs list list List runs cli:internal/cli/cmds_studio.go:101
tcp runs logs [run-id] logs [run-id] Stream run events (SSE) cli:internal/cli/cmds_studio.go:229
tcp runs runs Inspect and control agent runs cli:internal/cli/cmds_studio.go:94
tcp runs start start Dispatch a run for a project cli:internal/cli/cmds_studio.go:168
tcp runs steer <run-id> <message> steer <run-id> <message> Send an operator message to a running run cli:internal/cli/cmds_studio.go:211
tcp runs watch watch Stream the whole run feed (SSE) cli:internal/cli/cmds_studio.go:248
Command Use Summary Defined at
tcp templates get <template-id> get <template-id> Read one template cli:internal/cli/cmds_studio.go:572
tcp templates list list List templates cli:internal/cli/cmds_studio.go:552
tcp templates templates Browse project templates cli:internal/cli/cmds_studio.go:546
Command Use Summary Defined at
tcp agent agent Agent-facing helpers cli:internal/cli/cmds_misc.go:398
tcp agent manifest manifest Print the command surface as JSON cli:internal/cli/cmds_misc.go:403
Command Use Summary Defined at
tcp config config Manage CLI configuration cli:internal/cli/cmds_misc.go:23
tcp config get <key> get <key> Print one configuration value cli:internal/cli/cmds_misc.go:64
tcp config path path Print the config file path cli:internal/cli/cmds_misc.go:94
tcp config set <key> <value> set <key> <value> Set a configuration value in the config file cli:internal/cli/cmds_misc.go:80
tcp config show show Print the effective configuration cli:internal/cli/cmds_misc.go:29
Command Use Summary Defined at
tcp doctor doctor Probe every configured endpoint and report the live surface cli:internal/cli/cmds_misc.go:302
Command Use Summary Defined at
tcp models capacity capacity Read the routed-model catalogue (needs an operator key) cli:internal/cli/cmds_misc.go:202
tcp models list list List the models the gateway serves cli:internal/cli/cmds_misc.go:182
tcp models models The acumen model gateway: models, capacity and usage cli:internal/cli/cmds_misc.go:177
tcp models usage usage Read the gateway’s routing and spend statistics (operator key) cli:internal/cli/cmds_misc.go:221
Command Use Summary Defined at
tcp search search <query> search <query> Web search through the acumen search seat cli:internal/cli/cmds_misc.go:247
Command Use Summary Defined at
tcp status status Read the suite status document cli:internal/cli/cmds_misc.go:273
Command Use Summary Defined at
tcp version version Print the build identity cli:internal/cli/cmds_misc.go:482