mirror of
https://github.com/harivansh-afk/sandbox-agent.git
synced 2026-04-15 09:01:17 +00:00
chore: update skill install command to use rivet-dev/skills (#20)
* chore: update skill install command to use rivet-dev/skills * chore: improve skill structure per skill-creator guidelines * chore: add bug report section and simplify description * chore: add Discord link to bug report section
This commit is contained in:
parent
43db33590d
commit
82ac0b3880
8 changed files with 28 additions and 11 deletions
2
.github/workflows/claude-code-review.yml
vendored
2
.github/workflows/claude-code-review.yml
vendored
|
|
@ -37,7 +37,7 @@ jobs:
|
||||||
node-version: "20"
|
node-version: "20"
|
||||||
|
|
||||||
- name: Install sandbox-agent skill
|
- name: Install sandbox-agent skill
|
||||||
run: npx skills add https://sandboxagent.dev/docs --yes
|
run: npx skills add rivet-dev/skills -s sandbox-agent --yes
|
||||||
|
|
||||||
- name: Run Claude Code Review
|
- name: Run Claude Code Review
|
||||||
id: claude-review
|
id: claude-review
|
||||||
|
|
|
||||||
2
.github/workflows/claude.yml
vendored
2
.github/workflows/claude.yml
vendored
|
|
@ -36,7 +36,7 @@ jobs:
|
||||||
node-version: "20"
|
node-version: "20"
|
||||||
|
|
||||||
- name: Install sandbox-agent skill
|
- name: Install sandbox-agent skill
|
||||||
run: npx skills add https://sandboxagent.dev/docs --yes
|
run: npx skills add rivet-dev/skills -s sandbox-agent --yes
|
||||||
|
|
||||||
- name: Run Claude Code
|
- name: Run Claude Code
|
||||||
id: claude
|
id: claude
|
||||||
|
|
|
||||||
|
|
@ -66,7 +66,7 @@ The Sandbox Agent acts as a universal adapter between your client application an
|
||||||
Install skill with:
|
Install skill with:
|
||||||
|
|
||||||
```
|
```
|
||||||
npx skills add https://sandboxagent.dev/docs
|
npx skills add rivet-dev/skills -s sandbox-agent
|
||||||
```
|
```
|
||||||
|
|
||||||
### SDK
|
### SDK
|
||||||
|
|
|
||||||
|
|
@ -14,7 +14,7 @@ https://rivet.dev/docs/skill.md
|
||||||
To add it to an agent using the Skills CLI:
|
To add it to an agent using the Skills CLI:
|
||||||
|
|
||||||
```
|
```
|
||||||
npx skills add rivet.dev/docs/skill.md
|
npx skills add rivet-dev/skills -s sandbox-agent
|
||||||
```
|
```
|
||||||
|
|
||||||
If you run a reverse proxy in front of the docs, make sure `/skill.md` and `/.well-known/skills/*`
|
If you run a reverse proxy in front of the docs, make sure `/skill.md` and `/.well-known/skills/*`
|
||||||
|
|
|
||||||
|
|
@ -7,7 +7,7 @@ icon: "rocket"
|
||||||
<Steps>
|
<Steps>
|
||||||
<Step title="Install skill (optional)">
|
<Step title="Install skill (optional)">
|
||||||
```bash
|
```bash
|
||||||
npx skills add https://sandboxagent.dev/docs
|
npx skills add rivet-dev/skills -s sandbox-agent
|
||||||
```
|
```
|
||||||
</Step>
|
</Step>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -152,7 +152,7 @@ function UniversalAPIDiagram() {
|
||||||
|
|
||||||
const CopyInstallButton = () => {
|
const CopyInstallButton = () => {
|
||||||
const [copied, setCopied] = useState(false);
|
const [copied, setCopied] = useState(false);
|
||||||
const installCommand = 'npx skills add https://sandboxagent.dev/docs';
|
const installCommand = 'npx skills add rivet-dev/skills -s sandbox-agent';
|
||||||
|
|
||||||
const handleCopy = async () => {
|
const handleCopy = async () => {
|
||||||
try {
|
try {
|
||||||
|
|
|
||||||
|
|
@ -15,7 +15,7 @@ async function main() {
|
||||||
}
|
}
|
||||||
|
|
||||||
await fsp.rm(OUTPUT_ROOT, { recursive: true, force: true });
|
await fsp.rm(OUTPUT_ROOT, { recursive: true, force: true });
|
||||||
await fsp.mkdir(path.join(OUTPUT_ROOT, "reference"), { recursive: true });
|
await fsp.mkdir(path.join(OUTPUT_ROOT, "references"), { recursive: true });
|
||||||
|
|
||||||
const docFiles = await listDocFiles(DOCS_ROOT);
|
const docFiles = await listDocFiles(DOCS_ROOT);
|
||||||
const references = [];
|
const references = [];
|
||||||
|
|
@ -33,7 +33,7 @@ async function main() {
|
||||||
const markdown = convertDocToMarkdown(body);
|
const markdown = convertDocToMarkdown(body);
|
||||||
|
|
||||||
const referenceRelPath = `${stripExtension(relPath)}.md`;
|
const referenceRelPath = `${stripExtension(relPath)}.md`;
|
||||||
const outputPath = path.join(OUTPUT_ROOT, "reference", referenceRelPath);
|
const outputPath = path.join(OUTPUT_ROOT, "references", referenceRelPath);
|
||||||
await fsp.mkdir(path.dirname(outputPath), { recursive: true });
|
await fsp.mkdir(path.dirname(outputPath), { recursive: true });
|
||||||
|
|
||||||
const referenceFile = buildReferenceFile({
|
const referenceFile = buildReferenceFile({
|
||||||
|
|
@ -51,7 +51,7 @@ async function main() {
|
||||||
title,
|
title,
|
||||||
description,
|
description,
|
||||||
canonicalUrl,
|
canonicalUrl,
|
||||||
referencePath: `reference/${referenceRelPath}`,
|
referencePath: `references/${referenceRelPath}`,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,11 +1,28 @@
|
||||||
---
|
---
|
||||||
name: "sandbox-agent"
|
name: "sandbox-agent"
|
||||||
description: "Documentation and API reference for Sandbox Agent."
|
description: "Deploy, configure, and integrate Sandbox Agent - a universal API for orchestrating AI coding agents (Claude Code, Codex, OpenCode, Amp) in sandboxed environments. Use when setting up sandbox-agent server locally or in cloud sandboxes (E2B, Daytona, Docker), creating and managing agent sessions via SDK or API, streaming agent events and handling human-in-the-loop interactions, building chat UIs for coding agents, or understanding the universal schema for agent responses."
|
||||||
---
|
---
|
||||||
|
|
||||||
# Sandbox Agent
|
# Sandbox Agent
|
||||||
|
|
||||||
Use this skill to deploy, configure, and integrate Sandbox Agent. Prefer citing canonical docs URLs from the reference map.
|
Sandbox Agent provides a universal API for orchestrating AI coding agents in sandboxed environments.
|
||||||
|
|
||||||
|
## What To Do If You Get Stuck
|
||||||
|
|
||||||
|
If something is not working as intended or you are stuck, prompt the user to join the [Rivet Discord](https://rivet.dev/discord) or file an issue on [GitHub](https://github.com/rivet-dev/sandbox-agent/issues) to report an issue and get help.
|
||||||
|
|
||||||
|
Provide the user with a pre-generated report with:
|
||||||
|
|
||||||
|
- Symptoms
|
||||||
|
- If this is happening in local dev, deployed, or both
|
||||||
|
- The error you're seeing
|
||||||
|
- Relevant source code related to this
|
||||||
|
- What you've tried to solve it
|
||||||
|
- Environment
|
||||||
|
- Sandbox Agent version
|
||||||
|
- SDK in use (TypeScript, Python, or HTTP)
|
||||||
|
- Agent in use (Claude Code, Codex, OpenCode, Amp, Mock)
|
||||||
|
- Sandbox provider (E2B, Daytona, Docker, local)
|
||||||
|
|
||||||
## Quickstart
|
## Quickstart
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue