Skip to content

Commit 2150ad1

Browse files
committed
Add Docker install instructions and fix pip package name in README
Signed-off-by: Cong Wang <cwang@multikernel.io>
1 parent dd9344f commit 2150ad1

1 file changed

Lines changed: 38 additions & 1 deletion

File tree

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,48 @@ Based on the paper [Fork, Explore, Commit: OS Primitives for Agentic Exploration
1616
## Install
1717

1818
```
19-
pip install .
19+
pip install BranchContext
2020
```
2121

2222
Requires Python >= 3.10. No external dependencies.
2323

24+
### Docker
25+
26+
The Docker image ships with [BranchFS](https://github.com/multikernel/branchfs)
27+
built in — no need to install FUSE, compile Rust, or configure any filesystem
28+
yourself. Just pull the image and go:
29+
30+
```bash
31+
docker pull multikernel/branching
32+
```
33+
34+
Run directly with `docker run`:
35+
36+
```bash
37+
docker run --rm --device /dev/fuse --cap-add SYS_ADMIN \
38+
--security-opt apparmor:unconfined \
39+
-v $(pwd):/src multikernel/branching run -- make test
40+
```
41+
42+
Or use the `branching-docker` wrapper (in `integration/docker/`) which handles
43+
the Docker flags for you:
44+
45+
```bash
46+
branching-docker -w ./myproject run -- make test
47+
branching-docker -w . speculate -c "./fix_a.sh" -c "./fix_b.sh"
48+
branching-docker -w . best-of-n -n 5 -- ./solve.py
49+
```
50+
51+
The `-w` flag specifies a host directory to use as the workspace. It is
52+
bind-mounted into the container, and BranchFS is mounted on top automatically.
53+
Committed changes are written back to the host directory.
54+
55+
To build the image from source:
56+
57+
```bash
58+
docker build -t branching -f integration/docker/Dockerfile .
59+
```
60+
2461
## Quick start
2562

2663
```python

0 commit comments

Comments
 (0)