CLI Reference
Complete command reference for the TOSE CLI.
Global Options
These options are available for all commands:
| Option | Description |
|---|---|
--json | Output JSON (for scripting & AI agents) |
-y, --yes | Skip confirmation prompts |
--api-key <key> | Override API key |
--workspace <slug> | Override workspace |
--project <slug> | Override project |
tose login
Save your API key for future commands.
tose login
Prompts for your API key (must start with tose_sk_) and saves it to ~/.tose/config.json.
tose logout
Remove saved credentials.
tose logout
tose whoami
Show current user and workspace information.
tose whoami
tose init
Link the current directory to a workspace and project. Creates a .tose.json file.
tose init
Interactive prompts will guide you through selecting a workspace and project.
tose use
Set the active project globally (without .tose.json).
# Set active project
tose use workspace/project
tose use project
# Clear active project
tose use --clear
tose up
Smart deploy: auto-init + deploy in one command.
tose up
This command will create a project if needed, connect your Git repo, and trigger a deployment.
tose deploy
Deploy the linked project.
# Deploy current project
tose deploy
# Deploy specific project
tose deploy workspace/project
tose redeploy
Redeploy with current config (no rebuild, same image).
tose redeploy [project]
tose down
Stop the current deployment.
tose down [project]
tose restart
Restart pods without redeploying.
tose restart [project]
tose status
Show project status, pod health, resource usage, and latest deployment.
tose status [project]
Output includes:
- Project status (running, stopped, etc.)
- Pod count (ready/total) and individual pod status
- CPU and memory usage vs limits
- Latest deployment info
tose logs
View build or live logs.
# Stream live logs
tose logs -f
# View build logs
tose logs --build
# Follow build logs
tose logs --build -f
# Specific deployment
tose logs --deployment <id>
| Option | Description |
|---|---|
-f, --follow | Stream logs in real-time (WebSocket) |
-n, --lines <n> | Number of lines (default: 100) |
-d, --deployment <id> | Specific deployment ID |
--build | Show build logs instead of live logs |
tose open
Open the project URL in your default browser.
tose open [project]
tose env list
List all environment variables for the current project.
tose env list [project]
tose env set
Set one or more environment variables.
tose env set KEY1=value1 KEY2=value2 ...
tose env rm
Remove environment variables by key.
tose env rm KEY1 KEY2 ...
tose env push
Upload a local .env file to the project.
# Merge with existing
tose env push .env
# Replace all
tose env push .env --replace
tose env pull
Download environment variables to a local file.
tose env pull .env.local
tose domain list
List all domains with DNS and SSL status.
tose domain list [project]
tose domain add
Add a custom domain.
tose domain add example.com
tose domain rm
Remove a custom domain.
tose domain rm example.com
tose db list
List all databases in the current workspace.
tose db list
tose db create
Create a new managed database.
tose db create
Interactive prompts for name and type (postgresql, mysql, redis, mongodb).
tose db info
Show database connection details.
tose db info <name-or-id>
Displays host, port, username, database name, and connection string.
tose template catalog
Show available pre-built templates.
tose template catalog
Displays template name, description, default resources, and required environment variables.
tose template list
List deployed templates in the current workspace.
tose template list
tose template create
Create a template app. Prompts for required environment variables and deploys automatically.
# Interactive (prompts for name, env vars, then deploys)
tose template create
# With name
tose template create "My App"
The create flow:
- Select template (if multiple available)
- Enter app name
- Fill in required environment variables
- Auto-deploy
- Stream build logs
tose template info
Show template details including status, resources, and last deployment.
tose template info <slug>
tose template deploy
Deploy or redeploy a template.
tose template deploy <slug>
# Specify deploy mode
tose template deploy <slug> --mode build
tose template deploy <slug> --mode image
tose template stop
Stop a running template.
tose template stop <slug>
tose template delete
Delete a template and all its resources (K8s, domains, etc.).
tose template delete <slug>
tose template logs
View template build or live logs.
# Stream live logs
tose template logs <slug> -f
# View build logs
tose template logs <slug> --build
# Follow build logs
tose template logs <slug> --build -f
tose template env
Manage template environment variables.
# List env vars
tose template env list <slug>
# Set env vars
tose template env set <slug> KEY1=value1 KEY2=value2
# Remove env vars
tose template env rm <slug> KEY1 KEY2
tose generate
Generate a Dockerfile using AI analysis of your project.
tose generate
# With options
tose generate -o Dockerfile.prod --overwrite --auto-commit
| Option | Description |
|---|---|
-o, --output <path> | Output file path |
--overwrite | Overwrite existing Dockerfile |
--skip-commit | Skip git commit |
--auto-commit | Auto commit without prompt |
--auto-push | Auto push after commit |