CLI reference — Guidal Docs

This page covers the commands that carry the common workflows. For the complete surface see All commands; for flags on any command, guidal <group> <command> --help is always authoritative for the version you have installed.

Authentication

bash

guidal login          # sign in through the browser
guidal logout         # sign out
guidal whoami         # show the signed-in user
guidal auth status    # show session state
guidal version        # show the CLI version

Organizations and projects

bash

guidal orgs list
guidal orgs switch my-org

guidal projects list
guidal projects create my-app
guidal projects switch my-app

switch stores your working context so later commands do not need --org and --project. Both flags still work and override the stored value.

Services

bash

guidal services list
guidal services get api
guidal services create api --image ghcr.io/org/app:v1 --port 8080
guidal services deploy api --image ghcr.io/org/app:v2
guidal services scale api --replicas 3
guidal services delete api

Create a background worker with --type worker and no port.

Deployments

bash

guidal deployments list --service api
guidal deployments rollback --service api
guidal deployments diagnostics --service api

diagnostics is the first thing to run when a deploy fails and the reason is not obvious from logs.

Configuration

bash

guidal env list --service api
guidal env set LOG_LEVEL=info --service api
guidal env delete LOG_LEVEL --service api
guidal env import .env.production --service api

guidal secrets list --service api
guidal secrets set STRIPE_API_KEY --service api
guidal secrets delete STRIPE_API_KEY --service api

Secret values are never printed back. Both take effect on the next deploy.

Databases and Redis

Both engines use the db group.

bash

guidal db list
guidal db create demo-db --engine postgres
guidal db create cache --engine redis
guidal db get demo-db
guidal db link demo-db --service api
guidal db unlink demo-db --service api
guidal db proxy demo-db
guidal db credentials demo-db
guidal db delete demo-db

Backups and recovery:

bash

guidal db backups demo-db
guidal db backup demo-db
guidal db restore demo-db
guidal db metrics demo-db

Object storage

bash

guidal storage list
guidal storage create uploads
guidal storage ls uploads
guidal storage cp ./file.pdf uploads/file.pdf
guidal storage rm uploads/file.pdf
guidal storage presign uploads/file.pdf --expires 3600
guidal storage link uploads --service api
guidal storage delete uploads

Domains

bash

guidal domains list
guidal domains add app.example.com --service api
guidal domains verify app.example.com
guidal domains ssl app.example.com
guidal domains remove app.example.com

Cron jobs

bash

guidal cron list
guidal cron create nightly --image ghcr.io/org/app:v1 --schedule "0 2 * * *"
guidal cron trigger nightly
guidal cron suspend nightly
guidal cron resume nightly
guidal cron history nightly
guidal cron delete nightly

Observability

bash

guidal logs query --service api
guidal logs deployment --service api
guidal metrics service api
guidal metrics tenant

Registry

bash

guidal registry credentials
guidal registry repos
guidal registry artifacts my-app

Members and access

bash

guidal members list
guidal members invite someone@example.com --role developer
guidal members invites
guidal members role someone@example.com --role admin
guidal members remove someone@example.com

guidal api-keys list
guidal api-keys create ci-deploy
guidal api-keys delete ci-deploy

Networking and billing

bash

guidal network topology
guidal network endpoints

guidal billing status
guidal billing plan
guidal billing usage
guidal billing history

Billing commands are read-only. Changing a subscription is done in the dashboard.

MCP

bash

guidal mcp setup
guidal mcp status
guidal mcp serve
guidal mcp remove