Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 9 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,12 @@
<picture>
<source media="(prefers-color-scheme: dark)" srcset="assets/logo-dark-mode.png" />
<source media="(prefers-color-scheme: light)" srcset="assets/logo-light-mode.png" />
<img alt="Capsule" src="assets/logo-light-mode.png" width="80" />
<img alt="Capsule" src="assets/logo-light-mode.png" width="70" valign="bottom" />
</picture>

# `Capsule`

[![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://static.pepy.tech/personalized-badge/capsule-run?period=monthly&units=ABBREVIATION&left_color=grey&right_color=blue&right_text=ee&left_text=downloads/month(PyPI))](https://pypi.org/project/capsule-run)


[![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)

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

Expand Down Expand Up @@ -69,13 +67,6 @@ When you run `capsule run main.py` (or `main.ts`), your code is compiled into a

Each task operates within its own sandbox with configurable resource limits, ensuring that failures are contained and don't cascade to other parts of your workflow. The host system controls every aspect of execution, from CPU allocation via Wasm fuel metering to memory constraints and timeout enforcement.

## Ecosystem

| Package | Description |
|---------|-------------|
| [`capsule`](https://github.com/capsulerun/capsule) | Core runtime (this repository) |
| [`capsule-bash`](https://github.com/capsulerun/bash) | Sandboxed bash interface built from capsule |

## Getting Started

### Python
Expand Down Expand Up @@ -538,6 +529,13 @@ npm install && npm run build && npm link

Need help? [Open an issue](https://github.com/capsulerun/capsule/issues)

## Ecosystem

| Package | Description |
|---------|-------------|
| [`capsule`](https://github.com/capsulerun/capsule) | Core runtime (this repository) |
| [`capsule-bash`](https://github.com/capsulerun/bash) | Sandboxed bash interface built from capsule |

## Credits

Capsule builds on these open source projects:
Expand Down
Loading