4.3 KiB
layout, title, description, parent, toc
| layout | title | description | parent | toc |
|---|---|---|---|---|
| default | CLI Reference | Complete command reference for Sunbeam CLI | index | true |
CLI Reference
The Sunbeam CLI provides a comprehensive set of commands for managing local development environments.
Command Structure
sunbeam [global-options] <verb> [verb-options]
Global Options
| Option | Description | Default |
|---|---|---|
--env |
Target environment (local or production) |
local |
--context |
kubectl context override | Auto-determined |
--domain |
Domain suffix for production deploys | `` |
--email |
ACME email for cert-manager | `` |
Commands
Cluster Management
sunbeam up
Bring up the full local cluster including Lima VM and Kubernetes.
sunbeam up
sunbeam down
Tear down the Lima VM and local cluster.
sunbeam down
Status and Information
sunbeam status [target]
Show pod health across all namespaces, optionally filtered.
# All pods
sunbeam status
# Specific namespace
sunbeam status ory
# Specific service
sunbeam status ory/kratos
Manifest Management
sunbeam apply [namespace]
Build kustomize overlay, apply domain substitution, and apply manifests.
# Apply all manifests
sunbeam apply
# Apply specific namespace only
sunbeam apply lasuite
# Production environment with custom domain
sunbeam apply --env production --domain sunbeam.pt
Service Operations
sunbeam logs <ns/name> [-f]
View logs for a service.
# View recent logs
sunbeam logs ory/kratos
# Stream logs
sunbeam logs ory/kratos -f
sunbeam get <ns/name> [-o yaml|json|wide]
Get raw kubectl output for a resource.
# Get pod details
sunbeam get ory/kratos-abc -o yaml
sunbeam restart [target]
Rolling restart of services.
# Restart all services
sunbeam restart
# Restart specific namespace
sunbeam restart ory
# Restart specific service
sunbeam restart ory/kratos
sunbeam check [target]
Run functional service health checks.
# Check all services
sunbeam check
# Check specific service
sunbeam check ory/kratos
Build and Deployment
sunbeam build <what> [--push] [--deploy]
Build artifacts and optionally push and deploy.
# Build proxy
sunbeam build proxy
# Build and push
sunbeam build proxy --push
# Build, push, and deploy
sunbeam build proxy --deploy
Available build targets:
proxy,integration,kratos-admin,meetdocs-frontend,people-frontend,people
sunbeam mirror
Mirror amd64-only La Suite images.
sunbeam mirror
Secret Management
sunbeam seed
Generate and store all credentials in OpenBao.
sunbeam seed
sunbeam verify
End-to-end VSO + OpenBao integration test.
sunbeam verify
Bootstrap Operations
sunbeam bootstrap
Create Gitea orgs/repos and set up Lima registry.
sunbeam bootstrap
Kubernetes Operations
sunbeam k8s [kubectl args...]
Transparent kubectl passthrough.
# Any kubectl command
sunbeam k8s get pods -A
sunbeam bao [bao args...]
Run bao CLI inside OpenBao pod with root token.
# Run bao commands
sunbeam bao secrets list
User Management
sunbeam user list [--search email]
List identities.
# List all users
sunbeam user list
# Search by email
sunbeam user list --search user@example.com
sunbeam user get <target>
Get identity by email or ID.
sunbeam user get user@example.com
sunbeam user create <email> [--name name] [--schema schema]
Create identity.
sunbeam user create user@example.com --name "User Name"
sunbeam user delete <target>
Delete identity.
sunbeam user delete user@example.com
sunbeam user recover <target>
Generate recovery link.
sunbeam user recover user@example.com
sunbeam user disable <target>
Disable identity and revoke sessions.
sunbeam user disable user@example.com
sunbeam user enable <target>
Re-enable a disabled identity.
sunbeam user enable user@example.com
sunbeam user set-password <target> <password>
Set password for an identity.
sunbeam user set-password user@example.com newpassword