Skip to main content

CLI reference

tc is the command-line face of the vastframe API. It calls the same REST endpoints as the console and the MCP server, so anything you do here shows up in the console and the audit log.

tc login --dev
tc deploy ./my-app
tc access set groups --member "Finance - FP&A"
Availability

The CLI isn't published to a package registry yet, and tc login only supports the local dev token (--dev) for now; company sign-in for the CLI is coming with the platform's OAuth server. On the local stack, run it from the platform repository with npm run tc -- <command> (Node 24+), or link packages/cli so tc is on your PATH.

Commands​

CommandWhat it doesPage
tc login, tc whoamiSave credentials, show who you areLogin and whoami
tc deploy, tc redeployDeploy a folder; redeploy production with the current envDeploy
tc ls, tc status, tc logsList projects, show status, read build and runtime logsProjects and logs
tc rollback, tc promoteSwitch which deployment serves productionRollback and promote
tc accessWho can open the app; app rolesAccess
tc storageBuckets and filesStorage
tc envEnvironment variables and secretsEnvironment variables
tc deleteDelete a project for goodDelete
tc helpPrint usage (also tc with no command)

Global flags​

FlagShortDescription
--project NAME-pThe project to act on. Default: "name" in ./tc.json, else the current folder's name (slugified).
--jsonPrint the API response as JSON instead of human-readable text. Works on every command except login.
--quiet-qdeploy, redeploy and env set/unset --redeploy: don't print build progress
--help-hWith no command (tc --help), print usage. Subcommands don't have their own help: tc deploy --help runs the deploy.

Configuration​

tc login writes a config file; environment variables override it.

VariableDefaultDescription
TC_APIhttp://localhost:4780The vastframe API base URL (the CLI calls $TC_API/api/…)
TC_TOKENfrom the config fileBearer token sent on every request
TC_TENANTfrom the config fileTenant to act in, sent as X-TC-Tenant, when TC_API isn't a tenant host (for example localhost)
TC_CONFIG~/.config/tc/config.jsonPath to the config file
TC_DEV_TOKENdev-tokentc login --dev only: the base dev token
~/.config/tc/config.json
{
"api": "http://localhost:4780",
"token": "dev-token:ben.carter@contoso.com",
"tenant": "acme"
}

The file is written with mode 0600.

JSON output​

With --json, tc prints the API's response object (pretty-printed) and nothing else, so you can pipe it:

tc ls --json | jq -r '.[] | "\(.name)\t\(.latestDeployment.status)"'
tc deploy --json | jq -r .url

Each command page shows its JSON shape.

Exit codes and errors​

tc exits 0 on success and 1 on any error. Errors go to stderr as tc: CODE: message (storage errors add the fix on a second line). If the API can't be reached, it says so and suggests starting the local stack.

Was this page helpful?