Skip to content

Fix CLI examples in quickstart to use correct exec syntax #113

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

Merged
kcmartin merged 2 commits into from
Jan 26, 2026
Merged

Fix CLI examples in quickstart to use correct exec syntax #113

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
58be91e
Fix CLI examples in quickstart to use correct exec syntax
kcmartin Jan 26, 2026
76f31af
Run HTTP server in foreground for easier Ctrl+C stopping
kcmartin Jan 26, 2026
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
16 changes: 8 additions & 8 deletions src/content/docs/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Execute commands in your Sprite:
sprite exec echo "Hello, Sprites!"

# Run multiple commands
sprite exec "cd /tmp && ls -la"
sprite exec bash -c "cd /tmp && ls -la"

# Open an interactive shell
sprite console
Expand All @@ -88,15 +88,15 @@ Your Sprite comes pre-configured with common development tools (Node.js, Python,
See what's already installed and ready to use:

```bash
sprite exec "node --version && python3 --version && go version"
sprite exec bash -c "node --version && python3 --version && go version"
```

### Install a package

Install dependencies just like you would locally—they'll stick around:

```bash
sprite exec "pip install requests"
sprite exec pip install requests
```

### Create and read files
Expand All @@ -105,12 +105,12 @@ Files you create persist across sessions. Write once, read anytime:

```bash
# Create a file
sprite exec "echo 'Hello from my persistent Sprite!' > /home/sprite/greeting.txt"
sprite exec bash -c "echo 'Hello from my persistent Sprite!' > /home/sprite/greeting.txt"

# Disconnect, get coffee, come back later...
# Everything is still there!
sprite exec "cat /home/sprite/greeting.txt"
sprite exec "python -c 'import requests; print(requests.__version__)'"
sprite exec cat /home/sprite/greeting.txt
sprite exec python -c "import requests; print(requests.__version__)"
```

Unlike containers that reset on each run, your Sprite keeps your installed packages, files, and entire filesystem intact.
Expand All @@ -125,7 +125,7 @@ Start a simple Python server and get your public URL:

```bash
# Start a simple HTTP server on port 8080
sprite exec "python -m http.server 8080 &"
sprite exec bash -c "python -m http.server 8080 &"
Copy link
Contributor

@jbellerb jbellerb Jan 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As an example, it makes more sense to keep this in the foreground so the user can stop the server with Ctrl+C. Something like

sprite exec python -m http.server 8080

Copy link
Collaborator Author

@kcmartin kcmartin Jan 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, I addressed your comment, ptal


# Get your Sprite's public URL
sprite url
Expand All @@ -140,7 +140,7 @@ By default, your Sprite's URL requires authentication. To make it publicly acces
sprite url update --auth public
```

The default `sprite` auth mode allows access using a Sprite token with Bearer authentication.
The `default` auth mode requires a Sprite token with Bearer authentication.
</Callout>

### Test on-demand wake-up
Expand Down