Skip to content

Commit 42c853b

Browse files
committed
chore: docs
1 parent bd1620f commit 42c853b

32 files changed

Lines changed: 648 additions & 271 deletions

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ Yes. For orchestrating stateful, long-running tasks, we recommend pairing Secure
208208
<details>
209209
<summary>What are common use cases?</summary>
210210

211-
- [AI agent code evaluation and tool use](https://secureexec.dev/docs/use-cases/ai-agent-code-eval)
211+
- [AI agent code execution and tool use](https://secureexec.dev/docs/use-cases/ai-agent-code-exec)
212212
- [User-facing dev servers (Express, Hono, Next.js)](https://secureexec.dev/docs/use-cases/dev-servers)
213213
- MCP tool-code execution
214214
- [Sandboxed plugin / extension systems](https://secureexec.dev/docs/use-cases/plugin-systems)

docs/docs.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@
3939
{
4040
"group": "Use Cases",
4141
"pages": [
42-
"use-cases/ai-agent-code-eval",
42+
"use-cases/ai-agent-code-exec",
43+
"use-cases/code-mode",
4344
"use-cases/dev-servers",
4445
"use-cases/plugin-systems"
4546
]

docs/features/child-processes.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ description: Spawn child processes from sandboxed code.
44
icon: "terminal"
55
---
66

7+
<Card title="Example on GitHub" icon="github" href="https://github.com/anthropics/secure-exec/blob/main/examples/features/src/child-processes.ts">
8+
Runnable example for child process spawning.
9+
</Card>
10+
711
Sandboxed code can spawn child processes through the `CommandExecutor` interface, gated by the `childProcess` permission.
812

913
## Runnable example

docs/features/filesystem.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ description: Filesystem backends for sandboxed code.
44
icon: "folder"
55
---
66

7+
<Card title="Example on GitHub" icon="github" href="https://github.com/anthropics/secure-exec/blob/main/examples/features/src/filesystem.ts">
8+
Runnable example for filesystem backends.
9+
</Card>
10+
711
secure-exec supports three filesystem backends. The system driver controls which backend sandboxed code uses.
812

913
## Runnable example

docs/features/module-loading.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ description: How sandboxed code resolves and loads modules.
55
icon: "cubes"
66
---
77

8+
<Card title="Example on GitHub" icon="github" href="https://github.com/anthropics/secure-exec/blob/main/examples/features/src/module-loading.ts">
9+
Runnable example for module resolution and loading.
10+
</Card>
11+
812
Sandboxed code can `require()` and `import` modules through secure-exec's module resolution system.
913

1014
## Runnable example

docs/features/networking.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ description: Network access for sandboxed code.
44
icon: "globe"
55
---
66

7+
<Card title="Example on GitHub" icon="github" href="https://github.com/anthropics/secure-exec/blob/main/examples/features/src/networking.ts">
8+
Runnable example for network access control.
9+
</Card>
10+
711
Network access is deny-by-default. Enable it by setting `useDefaultNetwork: true` on the system driver and granting the `network` permission.
812

913
## Runnable example

docs/features/output-capture.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ description: Capture console output from sandboxed code.
44
icon: "message-lines"
55
---
66

7+
<Card title="Example on GitHub" icon="github" href="https://github.com/anthropics/secure-exec/blob/main/examples/features/src/output-capture.ts">
8+
Runnable example for capturing console output.
9+
</Card>
10+
711
Console output from sandboxed code is **not buffered** into result fields. `exec()` and `run()` do not return `stdout` or `stderr`. Use the `onStdio` hook to capture output.
812

913
## Runnable example

docs/features/permissions.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ description: Control what sandboxed code can access on the host.
44
icon: "lock"
55
---
66

7+
<Card title="Example on GitHub" icon="github" href="https://github.com/anthropics/secure-exec/blob/main/examples/features/src/permissions.ts">
8+
Runnable example for permission configuration.
9+
</Card>
10+
711
All host capabilities are **deny-by-default**. Sandboxed code cannot access the filesystem, network, child processes, or environment variables unless you explicitly allow it.
812

913
## Runnable example

docs/features/resource-limits.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ description: CPU time, memory, and payload size controls.
44
icon: "gauge"
55
---
66

7+
<Card title="Example on GitHub" icon="github" href="https://github.com/anthropics/secure-exec/blob/main/examples/features/src/resource-limits.ts">
8+
Runnable example for CPU and memory limits.
9+
</Card>
10+
711
Resource limits prevent sandboxed code from running forever or exhausting host memory.
812

913
## Runnable example

docs/features/typescript.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ description: Sandboxed type checking and compilation.
44
icon: "code"
55
---
66

7+
<Card title="Example on GitHub" icon="github" href="https://github.com/anthropics/secure-exec/blob/main/examples/features/src/typescript.ts">
8+
Runnable example for sandboxed TypeScript compilation.
9+
</Card>
10+
711
The `@secure-exec/typescript` companion package runs the TypeScript compiler inside a sandbox for safe type checking and compilation of untrusted code.
812

913
## Runnable example

0 commit comments

Comments
 (0)