Skip to content

Commit e9633a7

Browse files
kcmartinclaude
andcommitted
Refine quickstart based on feedback
- Made intro more concrete and actionable (VMs that feel like dev environments) - Added safety reassurance for install script - Broke up dense sections with subheadings and context - Added auto-wakeup callout earlier to highlight key feature - Made success message more actionable with concrete next steps Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
1 parent c90501e commit e9633a7

File tree

1 file changed

+34
-8
lines changed

1 file changed

+34
-8
lines changed

src/content/docs/quickstart.mdx

Lines changed: 34 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ description: Get up and running with Sprites in 5 minutes
66
import { Tabs, TabItem } from '@astrojs/starlight/components';
77
import { Callout, LinkCard, CardGrid } from '@/components/react';
88

9-
Think of a Sprite as your personal computer in the cloud—but better. Unlike containers that start from scratch each time, **Sprites are persistent VMs that wake up on demand**. Install dependencies once, clone repos, create files—everything stays exactly where you left it. When you're not using it, your Sprite goes to sleep. When you send a command or HTTP request, it wakes up instantly.
9+
Sprites are cloud VMs that feel like persistent dev environments. You can run commands, install packages, create files—and everything stays exactly how you left it. Unlike containers that reset each time, Sprites remember your entire filesystem between sessions.
10+
11+
The magic: when you're not using your Sprite, it goes to sleep. Send a command or HTTP request, and it wakes up instantly. No setup, no rebuilding—just pick up where you left off.
1012

1113
This guide will walk you through creating your first Sprite. In just a few minutes, you'll have a persistent development environment that responds to HTTP traffic and remembers everything between runs.
1214

@@ -18,7 +20,7 @@ Install with our install script (macOS/Linux):
1820
curl -fsSL https://sprites.dev/install.sh | sh
1921
```
2022

21-
This auto-detects your platform, downloads the binary with checksum verification, and installs to `~/.local/bin`.
23+
This script is safe to run—it auto-detects your platform, verifies checksums, and installs the latest CLI to `~/.local/bin`.
2224

2325
For Windows or manual installation, see [CLI Installation](/cli/installation) or download from [GitHub Releases](https://github.com/superfly/sprite-env/releases).
2426

@@ -71,17 +73,35 @@ sprite exec "cd /tmp && ls -la"
7173
sprite console
7274
```
7375

76+
<Callout type="note">
77+
**Auto-wakeup magic**: When you're not using your Sprite, it shuts down to save resources. When you run a command or hit its URL, it wakes up instantly—like magic. No manual starting or stopping required.
78+
</Callout>
79+
7480
## See Persistence in Action
7581

7682
Your Sprite comes pre-configured with common development tools (Node.js, Python, Go, Git, and more). Here's the magic: **everything you install or create persists between commands**.
7783

84+
### Check available runtimes
85+
86+
See what's already installed and ready to use:
87+
7888
```bash
79-
# Check available runtimes
8089
sprite exec "node --version && python3 --version && go version"
90+
```
91+
92+
### Install a package
93+
94+
Install dependencies just like you would locally—they'll stick around:
8195

82-
# Install a Python package
96+
```bash
8397
sprite exec "pip install requests"
98+
```
99+
100+
### Create and read files
101+
102+
Files you create persist across sessions. Write once, read anytime:
84103

104+
```bash
85105
# Create a file
86106
sprite exec "echo 'Hello from my persistent Sprite!' > /home/sprite/greeting.txt"
87107

@@ -95,7 +115,11 @@ Unlike containers that reset on each run, your Sprite keeps your installed packa
95115

96116
## Start a Web Server
97117

98-
Every Sprite has a unique HTTP URL and can serve traffic. Let's see it in action by starting a simple Python server:
118+
Every Sprite has a unique HTTP URL and can serve traffic. This makes it perfect for testing APIs, hosting prototypes, or running background services.
119+
120+
### Serve HTTP
121+
122+
Start a simple Python server and get your public URL:
99123

100124
```bash
101125
# Start a simple HTTP server on port 8080
@@ -105,16 +129,18 @@ sprite exec "python -m http.server 8080 &"
105129
sprite url
106130
```
107131

108-
Now visit the URL in your browser—you'll see Python's directory listing page. Your Sprite automatically routes HTTP traffic to port 8080 and wakes up to handle requests.
132+
Visit the URL in your browser—you'll see Python's directory listing page. Your Sprite automatically routes HTTP traffic to port 8080 and wakes up to handle requests.
133+
134+
### Test on-demand wakeup
109135

110-
Try this: close your terminal, wait a minute, then visit the URL again. Your Sprite wakes up automatically to serve the request. That's the magic of on-demand wakeup.
136+
Here's where it gets cool. Close your terminal, wait a minute, then visit the URL again. Your Sprite wakes up automatically to serve the request. That's the magic of on-demand wakeup—no manual starting or stopping required.
111137

112138
<Callout type="tip">
113139
**Managing Sprites**: 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.
114140
</Callout>
115141

116142
<Callout type="success">
117-
**You've got a working Sprite!** You've created a persistent environment, installed packages, created files, and served HTTP traffic—all of which will be there next time you connect. Everything from here is optional, but worth exploring when you're ready.
143+
**You've got a working Sprite!** You've created a persistent environment, installed packages, created files, and served HTTP traffic—all of which will be there next time you connect. Try cloning a repo, running a build, or deploying a tiny HTTP service to see what else you can do.
118144
</Callout>
119145

120146
---

0 commit comments

Comments
 (0)