diff --git a/cli/commands.mdx b/cli/commands.mdx index 55a56ef..1ad4d52 100644 --- a/cli/commands.mdx +++ b/cli/commands.mdx @@ -8,6 +8,8 @@ Complete reference for all `sprite` CLI commands. {/* AUTO-GENERATED-CONTENT:START - Do not edit this section */} + + ## Authentication Commands ### `sprite login` @@ -21,12 +23,14 @@ sprite login [flags] [api-url] **Options:** - `-o, --org ` - Specify organization - `-s, --sprite ` - Specify sprite +- `--force` - Skip the "already logged in" confirmation prompt - `-h, --help` - Show this help message **Examples:** ```bash sprite login sprite login -o my-org +sprite login --force # add another account without prompting sprite login https://custom-api.sprites.dev Related Commands: sprite auth --help Non-interactive token setup (CI/CD) @@ -140,6 +144,62 @@ sprite auth setup --token sprite auth setup --token "org-slug/org-id/token-id/token-value" ``` +### `sprite org set-default` + +sprite org set-default - Set the default organization + +```bash +sprite org set-default [alias:] +``` + +**Options:** +- `-h, --help` - Show this help message + +**Examples:** +```bash +sprite org set-default myorg # Set default org +sprite org set-default prod:myorg # Set org for 'prod' alias +``` + +### `sprite org keyring status` + +sprite org keyring status - Show current keyring status + +```bash +sprite org keyring status +``` + +**Options:** +- `-h, --help` - Show this help message + +### `sprite auth migrate` + +sprite auth migrate - Migrate token keys to URL-based format + +```bash +sprite auth migrate +``` + +### `sprite keyring` + +sprite keyring - Browse organization tokens stored in keyring + +```bash +sprite keyring +``` + +**Options:** +- `-h, --help` - Show this help message + +> Opens an interactive TUI to browse organization tokens. +> Use arrow keys to navigate, Enter to view tokens. +> Press 'v' to show/hide the selected token value. + +**Examples:** +```bash +sprite keyring +``` + ## Sprite Management ### `sprite create` @@ -217,16 +277,19 @@ sprite list [flags] - `-s, --sprite ` - Specify sprite - `-w, --watch` - Watch for live updates - `--prefix ` - Filter sprites by name prefix +- `--json` - Output sprite and organization details as JSON - `-h, --help` - Show this help message > Lists all sprites in the selected organization. > Use --prefix to filter sprites by name prefix. +> --json cannot be combined with --watch. **Examples:** ```bash sprite list sprite list -o myorg sprite list --prefix dev +sprite --json list | jq '.sprites[].name' ``` ### `sprite destroy` @@ -254,6 +317,160 @@ sprite create --help Create a new sprite sprite checkpoint --help Save state before destroying ``` +### `sprite info` + +sprite info - Show sprite info including URL and labels + +```bash +sprite info [flags] [sprite-name] +``` + +**Options:** +- `-o, --org ` - Specify organization +- `-s, --sprite ` - Specify sprite +- `-h, --help` - Show this help message + +**Examples:** +```bash +sprite info # Show info for selected sprite +sprite info my-sprite # Show info for a specific sprite +sprite info -o myorg my-sprite # Show info for a sprite in a specific org +Output: +Displays the sprite's URL, URL authentication setting, and labels. +Related Commands: +sprite config --help Show or update sprite configuration +sprite list --help List your sprites +``` + +### `sprite config` + +sprite config - Show or update sprite configuration + +```bash +sprite config [flags] [sprite-name] +sprite config update [flags] [sprite-name] +``` + +**Options:** +- `-o, --org ` - Specify organization +- `-s, --sprite ` - Specify sprite +- `-h, --help` - Show this help message + +**Examples:** +```bash +sprite config # Show current config for selected sprite +sprite config my-sprite # Show config for a specific sprite +sprite config update --url-auth public +sprite config update --label env:prod +Related Commands: +sprite config update --help Update sprite configuration +sprite info --help Show sprite info including URL and labels +``` + +### `sprite config update` + +sprite config update - Update sprite configuration + +```bash +sprite config update [flags] [sprite-name] +``` + +**Options:** +- `-o, --org ` - Specify organization +- `-s, --sprite ` - Specify sprite +- `--url-auth ` - URL authentication type: 'public' or 'sprite' +- `--private-access ` - Private URL access type: 'admins' or 'org_users' +- `--label