harivansh-afk/sandbox-agent
1
0
Fork 0
mirror of https://github.com/harivansh-afk/sandbox-agent.git synced 2026-04-17 09:02:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: simplify quickstart examples with --no-token default (#39)

Browse source
This commit is contained in:
Nathan Flurry 2026-01-30 00:03:23 -08:00 • committed by GitHub
parent a25991b00e
commit cea02983b9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 49 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

73
docs/quickstart.mdx
View file

@ -76,7 +76,7 @@ icon: "rocket"
```bash ```bash
curl -fsSL https://releases.rivet.dev/sandbox-agent/latest/install.sh | sh curl -fsSL https://releases.rivet.dev/sandbox-agent/latest/install.sh | sh
sandbox-agent server --token "$SANDBOX_TOKEN" --host 127.0.0.1 --port 2468 sandbox-agent server --no-token --host 0.0.0.0 --port 2468
``` ```
</Tab> </Tab>
@ -84,7 +84,7 @@ icon: "rocket"
Run without installing globally. Run without installing globally.
```bash ```bash
npx sandbox-agent server --token "$SANDBOX_TOKEN" --host 127.0.0.1 --port 2468 npx @sandbox-agent/cli server --no-token --host 0.0.0.0 --port 2468
``` ```
</Tab> </Tab>
@ -93,7 +93,7 @@ icon: "rocket"
```bash ```bash
npm install -g @sandbox-agent/cli npm install -g @sandbox-agent/cli
sandbox-agent server --token "$SANDBOX_TOKEN" --host 127.0.0.1 --port 2468 sandbox-agent server --no-token --host 0.0.0.0 --port 2468
``` ```
</Tab> </Tab>
@ -101,7 +101,7 @@ icon: "rocket"
If you're running from source instead of the installed CLI. If you're running from source instead of the installed CLI.
```bash ```bash
cargo run -p sandbox-agent -- server --token "$SANDBOX_TOKEN" --host 127.0.0.1 --port 2468 cargo run -p sandbox-agent -- server --no-token --host 0.0.0.0 --port 2468
``` ```
</Tab> </Tab>
@ -118,9 +118,45 @@ icon: "rocket"
</Tab> </Tab>
</Tabs> </Tabs>
Binding to `0.0.0.0` allows the server to accept connections from any network interface, which is required when running inside a sandbox where clients connect remotely.
<AccordionGroup> <AccordionGroup>
<Accordion title="Running without tokens"> <Accordion title="Configuring token">
If endpoint is not public, use `--no-token` to disable authentication. Most sandbox providers already secure their networking, so tokens are not required. Tokens are usually not required. Most sandbox providers (E2B, Daytona, etc.) already secure their networking at the infrastructure level, so the server endpoint is never publicly accessible. For local development, binding to `127.0.0.1` ensures only local connections are accepted.
If you need to expose the server on a public endpoint, use `--token "$SANDBOX_TOKEN"` to require authentication on all requests:
```bash
sandbox-agent server --token "$SANDBOX_TOKEN" --host 0.0.0.0 --port 2468
```
Then pass the token when connecting:
<Tabs>
<Tab title="TypeScript">
```typescript
const client = await SandboxAgent.connect({
baseUrl: "http://your-server:2468",
token: process.env.SANDBOX_TOKEN,
});
```
</Tab>
<Tab title="curl">
```bash
curl "http://your-server:2468/v1/sessions" \
-H "Authorization: Bearer $SANDBOX_TOKEN"
```
</Tab>
<Tab title="CLI">
```bash
sandbox-agent api sessions list \
--endpoint http://your-server:2468 \
--token "$SANDBOX_TOKEN"
```
</Tab>
</Tabs>
</Accordion> </Accordion>
<Accordion title="CORS"> <Accordion title="CORS">
If you're calling the server from a browser, see the [CORS configuration guide](/docs/cors). If you're calling the server from a browser, see the [CORS configuration guide](/docs/cors).
@ -149,7 +185,6 @@ icon: "rocket"
const client = await SandboxAgent.connect({ const client = await SandboxAgent.connect({
baseUrl: "http://127.0.0.1:2468", baseUrl: "http://127.0.0.1:2468",
token: process.env.SANDBOX_TOKEN,
}); });
await client.createSession("my-session", { await client.createSession("my-session", {
@ -163,7 +198,6 @@ icon: "rocket"
<Tab title="curl"> <Tab title="curl">
```bash ```bash
curl -X POST "http://127.0.0.1:2468/v1/sessions/my-session" \ curl -X POST "http://127.0.0.1:2468/v1/sessions/my-session" \
-H "Authorization: Bearer $SANDBOX_TOKEN" \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
-d '{"agent":"claude","agentMode":"build","permissionMode":"default"}' -d '{"agent":"claude","agentMode":"build","permissionMode":"default"}'
``` ```
@ -173,8 +207,7 @@ icon: "rocket"
```bash ```bash
sandbox-agent api sessions create my-session \ sandbox-agent api sessions create my-session \
--agent claude \ --agent claude \
--endpoint http://127.0.0.1:2468 \ --endpoint http://127.0.0.1:2468
--token "$SANDBOX_TOKEN"
``` ```
</Tab> </Tab>
</Tabs> </Tabs>
@ -193,7 +226,6 @@ icon: "rocket"
<Tab title="curl"> <Tab title="curl">
```bash ```bash
curl -X POST "http://127.0.0.1:2468/v1/sessions/my-session/messages" \ curl -X POST "http://127.0.0.1:2468/v1/sessions/my-session/messages" \
-H "Authorization: Bearer $SANDBOX_TOKEN" \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
-d '{"message":"Summarize the repository and suggest next steps."}' -d '{"message":"Summarize the repository and suggest next steps."}'
``` ```
@ -203,8 +235,7 @@ icon: "rocket"
```bash ```bash
sandbox-agent api sessions send-message my-session \ sandbox-agent api sessions send-message my-session \
--message "Summarize the repository and suggest next steps." \ --message "Summarize the repository and suggest next steps." \
--endpoint http://127.0.0.1:2468 \ --endpoint http://127.0.0.1:2468
--token "$SANDBOX_TOKEN"
``` ```
</Tab> </Tab>
</Tabs> </Tabs>
@ -227,16 +258,13 @@ icon: "rocket"
<Tab title="curl"> <Tab title="curl">
```bash ```bash
# Poll for events # Poll for events
curl "http://127.0.0.1:2468/v1/sessions/my-session/events?offset=0&limit=50" \ curl "http://127.0.0.1:2468/v1/sessions/my-session/events?offset=0&limit=50"
-H "Authorization: Bearer $SANDBOX_TOKEN"
# Stream events via SSE # Stream events via SSE
curl "http://127.0.0.1:2468/v1/sessions/my-session/events/sse?offset=0" \ curl "http://127.0.0.1:2468/v1/sessions/my-session/events/sse?offset=0"
-H "Authorization: Bearer $SANDBOX_TOKEN"
# Single-turn stream (post message and get streamed response) # Single-turn stream (post message and get streamed response)
curl -N -X POST "http://127.0.0.1:2468/v1/sessions/my-session/messages/stream" \ curl -N -X POST "http://127.0.0.1:2468/v1/sessions/my-session/messages/stream" \
-H "Authorization: Bearer $SANDBOX_TOKEN" \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
-d '{"message":"Hello"}' -d '{"message":"Hello"}'
``` ```
@ -246,19 +274,16 @@ icon: "rocket"
```bash ```bash
# Poll for events # Poll for events
sandbox-agent api sessions events my-session \ sandbox-agent api sessions events my-session \
--endpoint http://127.0.0.1:2468 \ --endpoint http://127.0.0.1:2468
--token "$SANDBOX_TOKEN"
# Stream events via SSE # Stream events via SSE
sandbox-agent api sessions events-sse my-session \ sandbox-agent api sessions events-sse my-session \
--endpoint http://127.0.0.1:2468 \ --endpoint http://127.0.0.1:2468
--token "$SANDBOX_TOKEN"
# Single-turn stream # Single-turn stream
sandbox-agent api sessions send-message-stream my-session \ sandbox-agent api sessions send-message-stream my-session \
--message "Hello" \ --message "Hello" \
--endpoint http://127.0.0.1:2468 \ --endpoint http://127.0.0.1:2468
--token "$SANDBOX_TOKEN"
``` ```
</Tab> </Tab>
</Tabs> </Tabs>