Quickstart
Get an app live in a few minutes. All three paths call the same Hub API and give the same result: a project with a production URL, a preview URL for the deployment, logs, and company sign-in in front of it.
Prerequisites
- Access to a vastframe console, for example
https://console.apps.contoso.com(self-hosted) orhttps://console.<your-org>.vastframe.app(vastframe cloud). To try everything on a laptop, follow Run it locally first; the console is then athttp://console.apps.localhost. - The Builder Hub role. Everyone has it by default unless your admin restricted project creation to certain people or groups.
- A folder with an app in it: a Vite/React app, a Node server, a Python (FastAPI, Flask, Streamlit) app, a folder with a
Dockerfile, or plain HTML. See Runtimes and detection.
On today's builds the MCP server and the CLI authenticate with a development token (dev-token, or dev-token:<email> to act as a particular person on a local stack). OAuth sign-in for MCP clients and the CLI, so nobody handles a token, is coming soon. The console always uses normal company sign-in.
Deploy
- Claude or Copilot (MCP)
- tc CLI
- Console (drag and drop)
-
Copy your MCP endpoint. It is
mcp.followed by your console's domain, plus/mcp: for examplehttps://mcp.apps.contoso.com/mcp. The console shows a ready-made snippet under Projects › New project › Or deploy from your tools. -
Add the server to your assistant. For Claude Code:
claude mcp add --transport http vastframe https://mcp.apps.contoso.com/mcp \--header "Authorization: Bearer dev-token"For VS Code with GitHub Copilot, add it to
.vscode/mcp.json:{"servers": {"vastframe": {"type": "http","url": "https://mcp.apps.contoso.com/mcp","headers": { "Authorization": "Bearer dev-token" }}}}Your organization may need to allow MCP servers in Copilot first.
-
Ask for a deploy. Open the folder in your assistant and say:
Deploy this folder to vastframe.
The assistant calls
create_projectanddeploy, then reports the production URL and the preview URL. If the app uses an integration that needs approval,deployasks for a one-line purpose and returns the access requests it created.
More prompts and the full tool list: Agents & MCP.
-
Sign in. Today's CLI saves a development token in
~/.config/tc/config.json:tc login --dev --api https://console.apps.contoso.comOn a local stack
tc login --devis enough (the API defaults tohttp://localhost:4780); add--as ben.carter@contoso.comto act as a fixture user. -
Deploy the folder.
tc deploy ./my-appDeploying /work/my-app → my-app (412.3 KB)deployment d7f3a2 queuedbuildingdeployingreadyLive: https://my-app.apps.contoso.comPreview: https://my-app--d7f3a2.apps.contoso.comThe project is created on the first deploy. Its name comes from
--project, else"name"intc.json, else the folder name. -
Check it.
tc status # deployments, * marks productiontc logs --tail 50 # build and runtime output
Every command: CLI reference.
-
Open the console and go to Projects › New project.
-
Name the project (for example
q3-variance), then drop a project folder on the drop zone. The console reads the folder in the browser and shows what it detected.node_modules,.git,distand.envfiles are skipped. -
Deploy. The console uploads the folder and streams the status live: queued, building, deploying, ready. When it's ready you get the production URL and the preview URL, and the project's Overview page opens.
Open the app
Open the production URL. You sign in with your company account once (single sign-on covers every app), and then the app loads.
New projects start with Only me access, so only you can open it. To share it:
tc access set team # your manager's direct reports, kept up to date
tc access set groups -m "Finance - FP&A" # specific groups or people
tc access set everyone # everyone in the organization
Or use the project's Access page in the console. See Access & security.
What you got
| Thing | Where |
|---|---|
| Production URL | https://<project>.apps.<domain> |
| Preview URL per deployment | https://<project>--<deployment-id>.apps.<domain> |
| Signed-in user in your server code | the X-TC-User header, or tc.auth.user(req) from the SDK |
| Signed-in user in the browser | GET /_tc/auth/me, or tc.auth.user() |
| A Postgres database | the project's Database page; DATABASE_URL in server code; tc.db in the SDK |
| File storage | the project's Storage page; tc.storage in the SDK |
| Logs | the project's Logs page, tc logs, or the MCP tool get_logs |
Next steps
- Add a database table and row-level security: Database and Studio.
- Configure services, integrations and buckets in
tc.json. - Build a complete team app: Walkthrough: a team app.