Skip to content

docs: sync command table with main.go #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Taure merged 1 commit into from
Apr 20, 2026
Merged

docs: sync command table with main.go #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 15 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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 <dir>` | Deploy Lua scripts to the engine |
| `asobi create <name> [--size xs\|s\|m\|l]` | Create an environment |
| `asobi deploy <env-name> [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 <env_id>` | Delete an environment and revoke its keys (idempotent) |
| `asobi env list [--ephemeral] [--json]` | List environments for the current game |
| `asobi stop <name>` | Stop a running environment |
| `asobi start <name>` | Start a stopped environment |
| `asobi delete <name>` | Delete an environment |
| `asobi destroy <env_id>` | 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 <k> <v>` | Set manual config (`url`, `api_key`) |
| `asobi config set <k> <v>` | Set manual config (`url`, `api_key`, `saas_url`) |
| `asobi config show` | Show current config |

## Ephemeral deploys (CI)
Expand Down
Loading