Skip to content

Update auto-generated CLI documentation #173

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

Open
sprites-ci wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update auto-generated CLI documentation #173

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
22 changes: 2 additions & 20 deletions src/content/docs/cli/commands.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,7 @@
- `-o, --org <name>` - Specify organization
- `-s, --sprite <name>` - Specify sprite
- `--skip-console Exit` - after creating instead of connecting to console
- `--label <label>` - Label to apply to the sprite (can be repeated)
- `-h, --help Show` - this help message

> Creates a new sprite with the specified name.
Expand Down Expand Up @@ -194,7 +195,7 @@

> Creates a .sprite file in the current directory to set the active sprite.
> This file will be used by other commands when no sprite is explicitly specified.
> Similar to 'nvm use' or 'asdf local' for version management.

Check warning on line 198 in src/content/docs/cli/commands.mdx

View workflow job for this annotation

GitHub Actions / Vale linter 

[vale] reported by reviewdog 🐶
[Fly.Spelling] Is 'asdf' a typo?

Raw Output:
{"message": "[Fly.Spelling] Is 'asdf' a typo?", "location": {"path": "src/content/docs/cli/commands.mdx", "range": {"start": {"line": 198, "column": 28}}}, "severity": "INFO"}
> If no sprite name is provided, shows an interactive list to choose from.

**Examples:**
Expand Down Expand Up @@ -505,31 +506,12 @@

### `sprite api`

sprite api - Make authenticated API calls with curl
Error: api requires a path argument

```bash
sprite api [flags] <path> [curl options]
```

**Options:**
- `-o, --org <name>` - Specify organization
- `-s, --sprite <name>` - Specify sprite
- `-h, --help Show` - this help message

> This command wraps curl to automatically add authentication headers.
> If a sprite is specified with -s, the path is relative to /v1/sprites/`<sprite-name>`/.
> If no sprite is specified, the path is relative to /v1/.
> Paths starting with /v1/sprites/ are always used as-is, ignoring any sprite context.
> All arguments after the path are passed directly to curl.

**Examples:**
```bash
sprite api -o myorg /sprites
sprite api -o myorg -s my-sprite /upgrade -X POST
sprite api -o myorg -s my-sprite /exec -X GET
sprite api -o myorg -s my-sprite /checkpoints
```

### `sprite upgrade`

sprite upgrade - Upgrade the sprite client to the latest version
Expand All @@ -542,7 +524,7 @@
- `--check Check` - for updates without installing
- `--force Force` - upgrade even if already up to date
- `--version <version>` - Upgrade to a specific version
- `--channel <channel>` - Release channel (release, rc, dev)

Check warning on line 527 in src/content/docs/cli/commands.mdx

View workflow job for this annotation

GitHub Actions / Vale linter 

[vale] reported by reviewdog 🐶
[Fly.Spelling] Is 'rc' a typo?

Raw Output:
{"message": "[Fly.Spelling] Is 'rc' a typo?", "location": {"path": "src/content/docs/cli/commands.mdx", "range": {"start": {"line": 527, "column": 53}}}, "severity": "INFO"}
- `-h, --help Show` - this help message

**Examples:**
Expand Down
Loading