CLI reference
CLI commands
Docker-grade ergonomics: contexts are servers, apps are jekyo.yaml files. Every command below links to its full page with flags and examples, or watch the demo first.
Servers & contexts
| Command | Description |
|---|---|
jekyo server preflight <user@host> | Check a server. Changes nothing. |
jekyo server install <user@host> | Turn a bare Ubuntu server into a ready cluster. Idempotent. |
jekyo server info | Cluster health, versions, disk, GPUs. |
jekyo server uninstall <context> | Return the server to clean. --purge-storage wipes data too. |
jekyo context ls | List servers. |
jekyo context use <name> | Switch the current server. |
jekyo context show | Endpoints and credentials for the current server. |
jekyo context export / import | Move a context to CI or another machine. |
Apps
| Command | Description |
|---|---|
jekyo init [template] | Write a jekyo.yaml. Prompts for template inputs and backups. |
jekyo up | Build and deploy. Idempotent and content-hashed. |
jekyo down [app] | Remove workloads. Volumes survive unless --volumes. |
jekyo ls | All apps with pods, domains, and revision. |
jekyo ps [app] | Pod detail. |
jekyo logs <app>[/<svc>] | Logs. -f follows, -t timestamps, --since 1h, --tail N. |
jekyo exec <app>/<svc> | Shell or command inside a pod. |
jekyo attach <app>/<svc> | Stream the main process output live. Ctrl+C detaches without stopping it. |
jekyo top [app] | Live resource dashboard: per-pod CPU, memory, restarts, node capacity bars. --json for one machine-readable snapshot. |
jekyo ui | Interactive terminal UI: navigate apps and services, live logs, CPU and memory graphs, and one-key restart, rollback, exec, attach. |
jekyo status <app> | Rollout state, URLs, certificates, recent warnings. |
jekyo restart <app>[/<svc>] | Rolling restart. |
jekyo history <app> | Deployed revisions. |
jekyo rollback <app> [rev] | Re-apply a previous revision. |
Builds & registries
| Command | Description |
|---|---|
jekyo build | Build and push images without deploying. |
jekyo images | Contents of the cluster registry. |
jekyo registry login <host> | Store credentials for an external private registry. |
Backups
| Command | Description |
|---|---|
jekyo backup config | Set the cluster's S3 target. Once per cluster. |
jekyo backup now <app>/<vol> | Snapshot immediately. |
jekyo backup ls <app>/<vol> | List snapshots. |
jekyo backup restore <app>/<vol> [snap] | Restore. Stops the app during restore, restarts after. |
Network
| Command | Description |
|---|---|
jekyo vpn peers | List WireGuard peers with handshake status. |
jekyo vpn add-peer <name> | Create a peer and save its config file. |
jekyo vpn rm-peer <name> | Revoke a peer. |
jekyo vpn config <peer> | Download a peer's config again. |
Escape hatches & agents
| Command | Description |
|---|---|
jekyo render | Print the exact Kubernetes YAML an app compiles to. |
jekyo kubectl -- <args> | Raw kubectl against the current context. |
jekyo schema | JSON Schema for jekyo.yaml. |
jekyo templates / inspect <name> | Browse the catalog; see a template's inputs. -o json for agents. |
jekyo skill install [--global] | Teach Claude Code, Codex, and Cursor the tool. |
jekyo update | Self-update to the latest release, checksum-verified. |
jekyo server harden | fail2ban and automatic security updates in one command. |
jekyo skill show | Print the full reference for any other agent. |
Conventions everywhere: --context <name> targets any server, -o json on list commands, meaningful exit codes, errors on stderr.