From ae3af20b9b364c1d5a07583e3e9e42bd19d78e47 Mon Sep 17 00:00:00 2001 From: Daniel Widgren Date: Mon, 20 Apr 2026 21:46:01 +0200 Subject: [PATCH] docs: sync command table with main.go MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit README's command list and its usage examples had drifted away from the actual CLI. From an onboarding audit: - `asobi deploy game/` doesn't work — deploy requires an env name: `asobi deploy [dir]`. Fixed the hosted and self-hosted quickstart snippets, and added `asobi create prod` before the first deploy. - Command table was missing `create`, `stop`, `start`, `delete`, and plain `envs`. Added. Clarified that `destroy` and `env list` are the scripting/CI variants. --- README.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index e8498c3..83452a1 100644 --- a/README.md +++ b/README.md @@ -21,8 +21,9 @@ ln -s $(pwd)/bin/asobi ~/bin/asobi # Authenticate via browser — opens the dashboard, you pick tenant/game/env asobi login -# Deploy Lua scripts to the engine -asobi deploy game/ +# Create an environment and deploy Lua scripts to it +asobi create prod +asobi deploy prod game/ # Check engine health asobi health @@ -33,12 +34,13 @@ asobi whoami ### Self-hosted -If you run your own engine without the hosted dashboard: +If you run your own engine without the hosted dashboard, skip `asobi login` +and point the CLI at your engine directly: ```bash asobi config set url https://your-engine.example.com asobi config set api_key ak_your_key_here -asobi deploy game/ +asobi deploy prod game/ ``` ## Commands @@ -48,12 +50,17 @@ asobi deploy game/ | `asobi login` | Authenticate via browser (ECDH device-code flow) | | `asobi logout` | Clear stored credentials | | `asobi whoami` | Show current session info | -| `asobi deploy ` | Deploy Lua scripts to the engine | +| `asobi create [--size xs\|s\|m\|l]` | Create an environment | +| `asobi deploy [dir]` | Deploy Lua scripts to an environment (`dir` defaults to `.`) | | `asobi deploy --ephemeral [--name N] [--json]` | Create a fresh ephemeral env (1h TTL) and return env_id + api_key | -| `asobi destroy ` | Delete an environment and revoke its keys (idempotent) | -| `asobi env list [--ephemeral] [--json]` | List environments for the current game | +| `asobi stop ` | Stop a running environment | +| `asobi start ` | Start a stopped environment | +| `asobi delete ` | Delete an environment | +| `asobi destroy ` | Delete by env_id and revoke its keys (idempotent; used by CI cleanup) | +| `asobi envs` | List your environments | +| `asobi env list [--ephemeral] [--json]` | Structured environment list for scripting | | `asobi health` | Check engine health | -| `asobi config set ` | Set manual config (`url`, `api_key`) | +| `asobi config set ` | Set manual config (`url`, `api_key`, `saas_url`) | | `asobi config show` | Show current config | ## Ephemeral deploys (CI)