Skip to content

Commit ecd1cba

Browse files
mavdolmavdol
authored
Update project goals (#176)
* add dark/light mode logo support and update project documentation * update project branding, documentation text, and repository URLs to capsulerun * update project descriptions and documentation to emphasize untrusted code execution * increase logo width in README.md * add release, npm download, and star count badges to README * update logo size and add PyPI/CI badges to README
1 parent 97fbd70 commit ecd1cba

21 files changed

Lines changed: 62 additions & 88 deletions

File tree

‎README.md‎

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
<div align="center">
22

3+
<picture>
4+
<source media="(prefers-color-scheme: dark)" srcset="assets/logo-dark-mode.png" />
5+
<source media="(prefers-color-scheme: light)" srcset="assets/logo-light-mode.png" />
6+
<img alt="Capsule" src="assets/logo-light-mode.png" width="100" />
7+
</picture>
8+
39
# `Capsule`
410

5-
**A secure, durable runtime for AI agents**
11+
[![CI](https://img.shields.io/github/actions/workflow/status/capsulerun/capsule/ci.yml?branch=main&label=CI)](https://github.com/capsulerun/capsule/actions/workflows/ci.yml) [![NPM Downloads](https://img.shields.io/npm/dm/@capsule-run%2Fcli?label=npm&color=orange)](https://www.npmjs.com/package/@capsule-run/cli) [![PyPI Downloads](https://img.shields.io/pypi/dm/capsule-run?label=PyPI&color=3775A9)](https://pypistats.org/packages/capsule-run)
612

7-
[![CI](https://github.com/mavdol/capsule/actions/workflows/ci.yml/badge.svg)](https://github.com/mavdol/capsule/actions/workflows/ci.yml)
813

914
[Getting Started](#getting-started) • [Documentation](#documentation) • [Issues](https://github.com/capsulerun/capsule/issues/new) • [Contributing](#contributing)
1015

@@ -14,17 +19,13 @@
1419

1520
## Overview
1621

17-
```Capsule``` is a runtime for coordinating AI agent tasks in isolated environments. It is designed to handle untrusted code execution, long-running workflows, large-scale processing, or even multi-agent systems.
18-
19-
Each task runs inside its own WebAssembly sandbox, providing:
22+
```Capsule``` is a runtime for executing untrusted code in isolated environments. Each task runs inside its own WebAssembly sandbox, providing:
2023

2124
- **Isolated execution**: Each task runs isolated from your host system
2225
- **Resource limits**: Set CPU, memory, and timeout limits per task
2326
- **Automatic retries**: Handle failures without manual intervention
2427
- **Lifecycle tracking**: Monitor which tasks are running, completed, or failed
2528

26-
This enables safe task-level execution of untrusted code within AI agent systems.
27-
2829
## How It Works
2930

3031
### With Python
@@ -58,15 +59,6 @@ export const analyzeData = task({
5859
// Your code runs safely in a Wasm sandbox
5960
return { processed: dataset.length, status: "complete" };
6061
});
61-
62-
// The "main" task is required as the entrypoint
63-
export const main = task({
64-
name: "main",
65-
compute: "HIGH"
66-
}, () => {
67-
return analyzeData([1, 2, 3, 4, 5]);
68-
});
69-
7062
```
7163

7264
> [!NOTE]
@@ -81,7 +73,7 @@ Each task operates within its own sandbox with configurable resource limits, ens
8173
| Package | Description |
8274
|---------|-------------|
8375
| [`capsule`](https://github.com/capsulerun/capsule) | Core runtime (this repository) |
84-
| [`capsule-bash`](https://github.com/capsulerun/bash) | Sandboxed bash interface built for AI agents |
76+
| [`capsule-bash`](https://github.com/capsulerun/bash) | Sandboxed bash interface built from capsule |
8577

8678
## Getting Started
8779

@@ -191,7 +183,7 @@ export const main = task({
191183
```
192184

193185
> [!TIP]
194-
> If you're looking for a pre-configured, ready-to-use solution, check out the [Python adapter](https://github.com/mavdol/capsule/tree/main/integrations/python-adapter) or [TypeScript adapter](https://github.com/mavdol/capsule/tree/main/integrations/typescript-adapter).
186+
> If you're looking for a pre-configured, ready-to-use solution, check out the [Python adapter](https://github.com/capsulerun/capsule/tree/main/integrations/python-adapter) or [TypeScript adapter](https://github.com/capsulerun/capsule/tree/main/integrations/typescript-adapter).
195187
196188
## Documentation
197189

@@ -433,7 +425,7 @@ You can create a `capsule.toml` file in your project root to set default options
433425
# capsule.toml
434426

435427
[workflow]
436-
name = "My AI Workflow"
428+
name = "My Workflow"
437429
version = "1.0.0"
438430
entrypoint = "src/main.py" # Default file when running `capsule run`
439431

@@ -520,7 +512,7 @@ Contributions are welcome!
520512
**Prerequisites:** Rust (latest stable), Python 3.13+, Node.js 22+
521513
522514
```bash
523-
git clone https://github.com/mavdol/capsule.git
515+
git clone https://github.com/capsulerun/capsule.git
524516
cd capsule
525517
526518
# Build and install CLI
@@ -543,7 +535,7 @@ npm install && npm run build && npm link
543535
3. **Run tests**: `cargo test` (only needed if modifying `crates/capsule-cli` or `crates/capsule-core`)
544536
4. **Open** a Pull Request
545537
546-
Need help? [Open an issue](https://github.com/mavdol/capsule/issues)
538+
Need help? [Open an issue](https://github.com/capsulerun/capsule/issues)
547539
548540
## Credits
549541

‎assets/logo-dark-mode.png‎

47.7 KB
Loading

‎assets/logo-light-mode.png‎

32.5 KB
Loading

‎crates/capsule-cli/Cargo.toml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
name = "capsule-run"
33
version = "0.8.9"
44
edition = "2024"
5-
description = "Secure WASM runtime to isolate and manage AI agent tasks"
5+
description = "Secure WASM runtime to execute untrusted code"
66
license = "Apache-2.0"
7-
repository = "https://github.com/mavdol/capsule"
7+
repository = "https://github.com/capsulerun/capsule"
88
keywords = ["webassembly", "sandbox", "isolation", "llm", "ai"]
99
categories = ["command-line-utilities", "wasm"]
1010
readme = "../../README.md"

‎crates/capsule-cli/docs/README-pypi.md‎

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,14 @@
1-
# capsule-run
2-
3-
**A secure, durable runtime for agentic workflows**
1+
# `capsule`
42

53
## Overview
64

7-
Capsule is a runtime for coordinating AI agent tasks in isolated environments. It is designed to handle untrusted code execution, long-running workflows, large-scale processing, or even multi-agent systems.
8-
9-
Each task runs inside its own WebAssembly sandbox, providing:
5+
`Capsule` is a runtime for executing untrusted code in isolated environments. Each task runs inside its own WebAssembly sandbox, providing:
106

117
- **Isolated execution**: Each task runs isolated from your host system
128
- **Resource limits**: Set CPU, memory, and timeout limits per task
139
- **Automatic retries**: Handle failures without manual intervention
1410
- **Lifecycle tracking**: Monitor which tasks are running, completed, or failed
1511

16-
This enables safe task-level execution of untrusted code within AI agent systems.
17-
1812
## Installation
1913

2014
```bash
@@ -251,5 +245,5 @@ def main() -> dict:
251245
252246
## Links
253247
254-
- [GitHub](https://github.com/mavdol/capsule)
255-
- [Issues](https://github.com/mavdol/capsule/issues)
248+
- [GitHub](https://github.com/capsulerun/capsule)
249+
- [Issues](https://github.com/capsulerun/capsule/issues)

‎crates/capsule-cli/npm/README.md‎

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,14 @@
1-
# capsule
2-
3-
**A secure, durable runtime for agentic workflows**
1+
# `capsule`
42

53
## Overview
64

7-
Capsule is a runtime for coordinating AI agent tasks in isolated environments. It is designed to handle untrusted code execution, long-running workflows, large-scale processing, or even multi-agent systems.
8-
9-
Each task runs inside its own WebAssembly sandbox, providing:
5+
`Capsule` is a runtime for executing untrusted code in isolated environments. Each task runs inside its own WebAssembly sandbox, providing:
106

117
- **Isolated execution**: Each task runs isolated from your host system
128
- **Resource limits**: Set CPU, memory, and timeout limits per task
139
- **Automatic retries**: Handle failures without manual intervention
1410
- **Lifecycle tracking**: Monitor which tasks are running, completed, or failed
1511

16-
This enables safe task-level execution of untrusted code within AI agent systems.
17-
1812
## Installation
1913

2014
```bash
@@ -282,5 +276,5 @@ export const main = task({
282276
283277
## Links
284278

285-
- [GitHub](https://github.com/mavdol/capsule)
286-
- [Issues](https://github.com/mavdol/capsule/issues)
279+
- [GitHub](https://github.com/capsulerun/capsule)
280+
- [Issues](https://github.com/capsulerun/capsule/issues)

‎crates/capsule-cli/npm/package.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@capsule-run/cli",
33
"version": "0.8.9",
4-
"description": "Secure WASM runtime to isolate and manage AI agent tasks",
4+
"description": "Secure WASM runtime to execute untrusted code",
55
"bin": {
66
"capsule": "./bin/capsule.js"
77
},
@@ -19,9 +19,9 @@
1919
"license": "Apache-2.0",
2020
"repository": {
2121
"type": "git",
22-
"url": "https://github.com/mavdol/capsule.git"
22+
"url": "https://github.com/capsulerun/capsule.git"
2323
},
24-
"homepage": "https://github.com/mavdol/capsule",
24+
"homepage": "https://github.com/capsulerun/capsule",
2525
"publishConfig": {
2626
"access": "public"
2727
},

‎crates/capsule-cli/pyproject.toml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ build-backend = "maturin"
55
[project]
66
name = "capsule-run"
77
version = "0.8.9"
8-
description = "Secure WASM runtime to isolate and manage AI agent tasks"
8+
description = "Secure WASM runtime to execute untrusted code"
99
readme = "docs/README-pypi.md"
1010
license = {text = "Apache-2.0"}
1111
requires-python = ">=3.10"
@@ -43,8 +43,8 @@ dependencies = [
4343
]
4444

4545
[project.urls]
46-
Homepage = "https://github.com/mavdol/capsule"
47-
Repository = "https://github.com/mavdol/capsule"
46+
Homepage = "https://github.com/capsulerun/capsule"
47+
Repository = "https://github.com/capsulerun/capsule"
4848

4949
[tool.maturin]
5050
bindings = "bin"

‎crates/capsule-cli/src/cli.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ use clap::{Parser, Subcommand};
33
#[derive(Parser)]
44
#[command(name = "capsule")]
55
#[command(version)]
6-
#[command(about = "A secure, durable runtime for AI agents", long_about = None)]
6+
#[command(about = "A secure, durable runtime for untrusted code", long_about = None)]
77
pub struct Cli {
88
#[command(subcommand)]
99
pub command: Commands,

‎crates/capsule-core/Cargo.toml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
name = "capsule-core"
33
version = "0.8.9"
44
edition = "2024"
5-
description = "Core library for Capsule - WASM runtime for AI agent isolation"
5+
description = "Core library for Capsule"
66
license = "Apache-2.0"
7-
repository = "https://github.com/mavdol/capsule"
7+
repository = "https://github.com/capsulerun/capsule"
88
keywords = ["webassembly", "sandbox", "isolation", "runtime", "wasm"]
99
categories = ["wasm"]
1010
readme = "../../README.md"

0 commit comments

Comments
 (0)