Skip to content

Commit 7531c46

Browse files
committed
update README
1 parent 18c09e4 commit 7531c46

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -73,14 +73,16 @@ Add to your MCP client (Claude Desktop, Cursor, etc.):
7373

7474
## Backend Examples
7575

76+
See the [CLI Reference](#cli-reference) for all arguments.
77+
7678
### Docker and Podman (default)
7779

7880
Local containers via Docker or Podman. Any OCI image works.
7981

8082
```bash
8183
kilntainers # Docker + debian-slim (defaults)
82-
kilntainers --image=alpine --engine=podman # Podman + Alpine
83-
kilntainers --image=node:22 --network # Node.js with networking
84+
kilntainers --image alpine --engine podman # Podman + Alpine
85+
kilntainers --image node:22 --network # Node.js with networking
8486
```
8587

8688
### Cloud Containers & VMs
@@ -90,8 +92,8 @@ kilntainers --image=node:22 --network # Node.js with networking
9092
Hosted containers with sub-second startup via [Modal.com](https://modal.com). Scales to thousands of parallel sandboxes. Supports GPUs.
9193

9294
```bash
93-
kilntainers --backend=modal
94-
kilntainers --backend=modal --gpu=A10G --region=us-east # GPU-accelerated
95+
kilntainers --backend modal
96+
kilntainers --backend modal --gpu A10G --region us-east # GPU-accelerated
9597
```
9698

9799
Authenticate via `modal setup` CLI or `--modal-token-id` / `--modal-token-secret` flags.
@@ -101,8 +103,8 @@ Authenticate via `modal setup` CLI or `--modal-token-id` / `--modal-token-secret
101103
Cloud hosted micro-VM sandboxes from [E2B](https://e2b.dev).
102104

103105
```bash
104-
kilntainers --backend=e2b # Default Debian image
105-
kilntainers --backend=e2b --e2b-api-key=ABCD --e2b-template=my-custom-alpine # Custom image
106+
kilntainers --backend e2b # Default Debian image
107+
kilntainers --backend e2b --e2b-api-key ABCD --e2b-template my-custom-alpine # Custom image
106108
```
107109

108110
Authenticate with `--e2b-api-key` CLI arg, or `E2B_API_KEY` environment variable.
@@ -113,15 +115,15 @@ Runs [go-busybox](https://github.com/rcarmo/go-busybox) in a WebAssembly sandbox
113115

114116
```bash
115117
uv tool install kilntainers[wasm] # WASM support is an optional dependency (+15MB)
116-
kilntainers --backend=go_busybox
118+
kilntainers --backend go_busybox
117119
```
118120

119121
### WASM Runner
120122

121123
Run a custom WASM module as the sandbox backend. Provides agents a set tools compiled to WebAssembly, and an isolated filesystem.
122124

123125
```bash
124-
kilntainers --backend=wasm --wasm-path=./my_tool.wasm
126+
kilntainers --backend wasm --wasm-path ./my_tool.wasm
125127
```
126128

127129
## Installation

0 commit comments

Comments
 (0)