Skip to main content

Deploy with the CLI

The tc CLI is a thin client over the Hub API. This page covers deploying; the CLI reference lists every command.

Sign in​

tc login --dev # local stack, API at http://localhost:4780
tc login --dev --api https://console.apps.contoso.com
tc whoami

The CLI saves its config to ~/.config/tc/config.json. Environment variables override it: TC_API, TC_TOKEN, TC_TENANT (the tenant to act in when the API address isn't a tenant host) and TC_CONFIG (another config file).

Availability

tc login --dev stores a development token. Interactive sign-in through your identity provider is coming soon.

Deploy​

tc deploy # the current folder
tc deploy ./dashboard # another folder
tc deploy ./dashboard -p q3-variance

The project name is, in order: --project / -p, the "name" field in tc.json, or the folder name. The project is created if it doesn't exist.

The CLI tars the folder (excluding node_modules, .git, .venv, venv, __pycache__, .env, .DS_Store), uploads it, follows the status stream, and prints the URLs. If the build fails it prints the last 40 lines of the build log.

Preview without switching production​

tc deploy --preview
# Preview ready: https://q3-variance--x81k2c.apps.contoso.com

Promote it later with tc promote x81k2c.

Tell approvers why​

tc deploy --purpose "Weekly AR aging report for the Controller, read-only"

--purpose is the one line approvers see on access requests this deploy creates. You can also put it in tc.json.

After deploying​

tc ls # your projects with their URLs and latest deployment
tc status # this project's deployments; * marks production
tc logs --build # build output of the latest deployment
tc logs --runtime --tail 500 # runtime output
tc rollback # production → the previous ready deployment
tc rollback --to d7f3a2 # production → a specific deployment

In CI​

The CLI reads TC_API and TC_TOKEN from the environment, so a pipeline step can deploy without a saved config:

TC_API=https://console.apps.contoso.com TC_TOKEN=$VASTFRAME_TOKEN tc deploy ./app -p q3-variance
Availability

A ready-made GitHub Action and Azure Pipelines task using workload identity federation (no stored secret) is planned. vastframe does not host git or receive webhooks.

Was this page helpful?