Skip to content

Commit 710e74f

Browse files
Update auto-generated CLI documentation
1 parent f8ae6f1 commit 710e74f

File tree

1 file changed

+36
-11
lines changed

1 file changed

+36
-11
lines changed

src/content/docs/cli/commands.mdx

Lines changed: 36 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -229,10 +229,10 @@ sprite list --prefix dev
229229

230230
### `sprite destroy`
231231

232-
Destroy the current sprite
232+
Destroy a sprite
233233

234234
```bash
235-
sprite destroy [options]
235+
sprite destroy [options] [sprite-name]
236236
```
237237

238238
**Options:**
@@ -245,8 +245,9 @@ sprite destroy [options]
245245

246246
**Examples:**
247247
```bash
248-
sprite destroy
249-
sprite destroy -o myorg -s mysprite
248+
sprite destroy mysprite
249+
sprite destroy -o myorg mysprite
250+
sprite destroy -s mysprite
250251
sprite destroy --force
251252
```
252253

@@ -319,40 +320,64 @@ sprite console -o myorg -s mysprite
319320

320321
### `sprite checkpoint create`
321322

322-
Error: sprite name required: use -s flag or create a .sprite file
323+
Create a new checkpoint
323324

324325
```bash
325326
sprite checkpoint create
326327
```
327328

329+
**Options:**
330+
- `-c, --comment <string>` - Optional comment to describe this checkpoint
331+
- `-h, --help` - Show help for this command
332+
328333
### `sprite checkpoint list`
329334

330-
Error: sprite name required: use -s flag or create a .sprite file
335+
List all checkpoints
331336

332337
```bash
333-
sprite checkpoint list
338+
sprite checkpoint list [options]
334339
```
335340

336341
**Aliases:** `sprite checkpoint ls`, `sprite checkpoints ls`
337342

343+
**Options:**
344+
- `-h, --help` - Show help for this command
345+
- `-h, --history <string>` - Filter by history version Include auto-generated checkpoints
346+
338347
### `sprite checkpoint info`
339348

340-
Error: sprite name required: use -s flag or create a .sprite file
349+
Show information about a specific checkpoint
350+
351+
```bash
352+
sprite checkpoint info <version-id>
353+
```
354+
355+
**Options:**
356+
- `-h, --help` - Show help for this command
341357

358+
**Examples:**
342359
```bash
343-
sprite checkpoint info
360+
sprite checkpoint info v2
344361
```
345362

346363
### `sprite checkpoint delete`
347364

348-
Error: sprite name required: use -s flag or create a .sprite file
365+
Delete a checkpoint (soft delete)
349366

350367
```bash
351-
sprite checkpoint delete
368+
sprite checkpoint delete <version-id>
352369
```
353370

354371
**Aliases:** `sprite checkpoint rm`
355372

373+
**Options:**
374+
- `-h, --help` - Show help for this command
375+
376+
**Examples:**
377+
```bash
378+
sprite checkpoint delete v3
379+
```
380+
356381
### `sprite restore`
357382

358383
Restore from a checkpoint version

0 commit comments

Comments
 (0)