Skip to content

Commit 5f85e12

Browse files
author
molty3000
committed
docs: add install section — go install, from source, binary download
1 parent af838f8 commit 5f85e12

1 file changed

Lines changed: 33 additions & 1 deletion

File tree

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,42 @@ kode run "Fix the OOM bug in default-hooks.js"
2222
| **Sandbox-ready** | `kode run --sandbox` → isolated Docker container, destroyed on exit |
2323
| **Single binary** | `go build` → one file. Drop it anywhere. |
2424

25+
## Install
26+
27+
### go install (recommended)
28+
29+
```bash
30+
go install github.com/BackendStack21/kode/cmd/kode@latest
31+
```
32+
33+
Zero dependencies — the binary compiles in seconds.
34+
35+
### From source
36+
37+
```bash
38+
git clone https://github.com/BackendStack21/kode.git
39+
cd kode
40+
go build -o kode ./cmd/kode
41+
```
42+
43+
### Binary download
44+
45+
```bash
46+
# Linux amd64
47+
curl -fsSL https://github.com/BackendStack21/kode/releases/latest/download/kode-linux-amd64 -o kode
48+
chmod +x kode
49+
sudo mv kode /usr/local/bin/
50+
51+
# macOS arm64 (Apple Silicon)
52+
curl -fsSL https://github.com/BackendStack21/kode/releases/latest/download/kode-darwin-arm64 -o kode
53+
chmod +x kode
54+
sudo mv kode /usr/local/bin/
55+
```
56+
2557
## Quick Start
2658

2759
```bash
28-
# Set your API key
60+
# Set your API key (Deepseek, OpenAI, or any compatible provider)
2961
export DEEPSEEK_API_KEY=sk-...
3062

3163
# Run a task

0 commit comments

Comments
 (0)