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"
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
| Command | What it does | Page |
|---|---|---|
tc login, tc whoami | Save credentials, show who you are | Login and whoami |
tc deploy, tc redeploy | Deploy a folder; redeploy production with the current env | Deploy |
tc ls, tc status, tc logs | List projects, show status, read build and runtime logs | Projects and logs |
tc rollback, tc promote | Switch which deployment serves production | Rollback and promote |
tc access | Who can open the app; app roles | Access |
tc storage | Buckets and files | Storage |
tc env | Environment variables and secrets | Environment variables |
tc delete | Delete a project for good | Delete |
tc help | Print usage (also tc with no command) |
Global flags
| Flag | Short | Description |
|---|---|---|
--project NAME | -p | The project to act on. Default: "name" in ./tc.json, else the current folder's name (slugified). |
--json | Print the API response as JSON instead of human-readable text. Works on every command except login. | |
--quiet | -q | deploy, redeploy and env set/unset --redeploy: don't print build progress |
--help | -h | With 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.
| Variable | Default | Description |
|---|---|---|
TC_API | http://localhost:4780 | The vastframe API base URL (the CLI calls $TC_API/api/…) |
TC_TOKEN | from the config file | Bearer token sent on every request |
TC_TENANT | from the config file | Tenant to act in, sent as X-TC-Tenant, when TC_API isn't a tenant host (for example localhost) |
TC_CONFIG | ~/.config/tc/config.json | Path to the config file |
TC_DEV_TOKEN | dev-token | tc login --dev only: the base dev token |
{
"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.