Skip to content

Commit 8aaf2f3

Browse files
committed
Merge branch 'main' into remove-basic-auth
2 parents 3a9ab2b + 3bf422d commit 8aaf2f3

File tree

2 files changed

+15
-33
lines changed

2 files changed

+15
-33
lines changed

.github/workflows/ci.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ jobs:
5151

5252
- name: Generate CLI Docs
5353
run: pnpm generate:cli-docs
54+
env:
55+
SKIP_CLI_TESTS: 'true'
5456

5557
- name: Commit generated CLI docs
5658
run: |

src/content/docs/cli/commands.mdx

Lines changed: 13 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ These options work with any command:
2727
Authenticate with Fly.io
2828

2929
```bash
30-
sprite login [-o <org>]
30+
sprite login [api-url] [-o <org>]
3131
```
3232

3333
**Options:**
@@ -41,6 +41,7 @@ sprite login [-o <org>]
4141
```bash
4242
sprite login
4343
sprite login -o my-org
44+
sprite login https://custom-api.sprites.dev
4445
```
4546

4647
### `sprite logout`
@@ -127,7 +128,7 @@ sprite org keyring enable
127128

128129
### `sprite auth setup`
129130

130-
Set up authentication from a token
131+
Set up authentication using a pre-generated token.
131132

132133
```bash
133134
sprite auth setup --token <token>
@@ -253,39 +254,35 @@ sprite destroy --force
253254

254255
### `sprite exec`
255256

256-
Execute a command in the sprite environment or list running sessions
257+
Execute a command in the sprite environment
257258

258259
```bash
259-
sprite exec [options] [command] [args...]
260+
sprite exec [options] <command> [args...]
260261
```
261262

262263
**Aliases:** `sprite x`
263264

264265
**Options:**
265-
- `-d, --detachable` - Create a detachable tmux session
266266
- `-d, --dir <string>` - Working directory for the command
267267
- `-e, --env <string>` - Environment variables (KEY=value,KEY2=value2)
268+
- `-f, --file <value>` - Upload file before exec (source:dest format, can be repeated)
268269
- `-h, --help` - Show help for this command Use HTTP/1.1 POST /exec instead of WebSockets (non-TTY only)
269-
- `-i, --id <string>` - Attach to existing session by ID
270270
- `-o, --o <string>` - Organization to use (shorthand)
271271
- `-o, --org <string>` - Organization to use
272272
- `-s, --s <string>` - Sprite to use (shorthand)
273273
- `-s, --sprite <string>` - Sprite to use
274274
- `-t, --tty` - Allocate a pseudo-TTY
275275

276-
> When no command is specified, lists all running sessions in the sprite.
277276
> When using -tty, terminal environment variables (TERM, COLORTERM, LANG, LC_ALL)
278277
> are automatically passed through from your local environment.
279-
> When using -detachable, creates a tmux session that can be detached and reattached.
278+
> Use 'sprite sessions' to list, attach to, or kill running sessions.
280279
281280
**Examples:**
282281
```bash
283-
sprite exec # List running sessions
284282
sprite exec ls -la
285283
sprite exec -dir /app echo hello world
286284
sprite exec -env KEY=value,FOO=bar env
287285
sprite exec -tty /bin/bash
288-
sprite exec -detachable /bin/bash --login
289286
sprite exec -o myorg -s mysprite npm start
290287
```
291288

@@ -300,7 +297,6 @@ sprite console [options]
300297
**Aliases:** `sprite c`
301298

302299
**Options:**
303-
- `-d, --detachable` - Deprecated: all sessions are now detachable by default (hidden, no-op)
304300
- `-h, --help` - Show help for this command
305301
- `-o, --o <string>` - Organization to use (shorthand)
306302
- `-o, --org <string>` - Organization to use
@@ -323,56 +319,40 @@ sprite console -o myorg -s mysprite
323319

324320
### `sprite checkpoint create`
325321

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

328324
```bash
329325
sprite checkpoint create
330326
```
331327

332-
**Options:**
333-
- `-c, --comment <string>` - Optional comment to describe this checkpoint
334-
- `-h, --help` - Show help for this command
335-
336328
### `sprite checkpoint list`
337329

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

340332
```bash
341-
sprite checkpoint list [options]
333+
sprite checkpoint list
342334
```
343335

344336
**Aliases:** `sprite checkpoint ls`, `sprite checkpoints ls`
345337

346-
**Options:**
347-
- `-h, --help` - Show help for this command
348-
- `-h, --history <string>` - Filter by history version
349-
350338
### `sprite checkpoint info`
351339

352-
Error: Failed to get checkpoint info: API returned status 500: Failed to get checkpoint: failed to get checkpoint: checkpoint not found: checkpoint with path checkpoints/--help not found
340+
Error: sprite name required: use -s flag or create a .sprite file
353341

354342
```bash
355343
sprite checkpoint info
356344
```
357345

358346
### `sprite checkpoint delete`
359347

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

362350
```bash
363-
sprite checkpoint delete <version-id>
351+
sprite checkpoint delete
364352
```
365353

366354
**Aliases:** `sprite checkpoint rm`
367355

368-
**Options:**
369-
- `-h, --help` - Show help for this command
370-
371-
**Examples:**
372-
```bash
373-
sprite checkpoint delete v3
374-
```
375-
376356
### `sprite restore`
377357

378358
Restore from a checkpoint version

0 commit comments

Comments
 (0)