Skip to content

Commit d0e1c3b

Browse files
committed
Create README.md
1 parent e47a00b commit d0e1c3b

1 file changed

Lines changed: 57 additions & 0 deletions

File tree

README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# WASI Builder
2+
3+
A Docker-based builder for creating [WASI (WebAssembly System Interface)](https://wasi.dev/) components from Rust source code using the [cargo-component](https://github.com/bytecodealliance/cargo-component) tool.
4+
5+
## Features
6+
7+
- Builds WASI components from Rust crates
8+
- Supports both debug and release modes
9+
- Secure sandboxed build environment
10+
- Reproducible builds with fixed versions
11+
- Multi-architecture support (amd64, arm64)
12+
13+
## Development
14+
15+
```bash
16+
# Install Task (if not already installed)
17+
curl -sL https://taskfile.dev/install.sh | sh
18+
19+
# Setup buildx for multi-arch builds
20+
task setup-buildx
21+
22+
# Clean up buildx
23+
task clean
24+
```
25+
26+
## Quick Start
27+
28+
```bash
29+
# Build the Docker image
30+
task build
31+
32+
# Test the build
33+
task test
34+
```
35+
36+
## Usage
37+
38+
The container expects your Rust component to be mounted at `/docker/<component-name>` and will output built WASM files to the specified directory.
39+
40+
### Container Arguments
41+
42+
```
43+
entrypoint <component-path> --out-dir <output-path> [--debug]
44+
```
45+
46+
- `component-path`: Relative path to your Rust component (from `/docker`)
47+
- `--out-dir`: Output directory for WASM artifacts
48+
- `--debug`: Build in debug mode (default: release)
49+
50+
## Build Targets
51+
52+
- Target: `wasm32-wasip1`
53+
- Output: `.wasm` files compatible with WASI runtime
54+
55+
## License
56+
57+
This project is part of the [Lay3rLabs](https://github.com/Lay3rLabs) ecosystem.

0 commit comments

Comments
 (0)