Skip to content

Commit 14114dd

Browse files
kcmartinclaude
andcommitted
Fix sprite destroy syntax to require -s flag
The CLI reference documents `sprite destroy` as requiring the -s flag to specify a sprite name, but several docs used a positional argument. Updated all occurrences to use the correct `-s sprite-name` syntax. Co-Authored-By: Claude Opus 4.5 <[email protected]>
1 parent d252013 commit 14114dd

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

scripts/generate-cli-docs/cli-runner.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ export async function createTestSprite(): Promise<string> {
119119
const useResult = await runCommand(['sprite', 'use', spriteName]);
120120
if (!useResult.success) {
121121
// Try to cleanup
122-
await runCommand(['sprite', 'destroy', spriteName]);
122+
await runCommand(['sprite', 'destroy', '-s', spriteName]);
123123
throw new Error(`Failed to set test sprite: ${useResult.stderr}`);
124124
}
125125

src/content/docs/quickstart.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Set it as your active Sprite to avoid adding `-s my-first-sprite` to every comma
5858
sprite use my-first-sprite
5959
```
6060

61-
Use `sprite list` to see all your Sprites, or `sprite destroy my-first-sprite` when you're done with one. You can have multiple Sprites running simultaneously—each with its own isolated environment.
61+
Use `sprite list` to see all your Sprites, or `sprite destroy -s my-first-sprite` when you're done with one. You can have multiple Sprites running simultaneously—each with its own isolated environment.
6262

6363
## Run Commands
6464

src/content/docs/sprites.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ sprite exec python -c "print('hello')"
3131
sprite exec "for i in {1..10}; do date +%T; sleep 0.5; done"
3232

3333
# Destroy when done
34-
sprite destroy my-sprite
34+
sprite destroy -s my-sprite
3535
```
3636
</TabItem>
3737

@@ -783,7 +783,7 @@ Always clean up Sprites when you're done:
783783
<Tabs>
784784
<TabItem label="CLI">
785785
```bash
786-
sprite destroy my-sprite
786+
sprite destroy -s my-sprite
787787
```
788788
</TabItem>
789789

src/content/docs/working-with-sprites.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ sprite list --prefix "dev-"
188188
### Destroy
189189

190190
```bash
191-
sprite destroy my-sprite
191+
sprite destroy -s my-sprite
192192
```
193193

194194
<Callout type="warning">

0 commit comments

Comments
 (0)