Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Showing 1 changed file with 51 additions and 1 deletion.
| @@ -6,11 +6,57 @@ make the failing test pass, and measure how often it actually does. | ||
| 6 | 6 | The code is the byproduct. The deliverable is [METRICS.md](METRICS.md). |
| 7 | 7 | [PLAN.md](PLAN.md) is the build plan this follows. |
| 8 | 8 | |
| 9 | - ## Quick start | |
| 9 | + ## Install | |
| 10 | + | |
| 11 | + Codey is one static binary with nothing to install alongside it, so there are | |
| 12 | + three ways to get it and they differ only in what you need to have already. | |
| 13 | + | |
| 14 | + **A release.** The [releases page](https://github.com/johannSo/codey/releases) | |
| 15 | + has an archive for Linux and macOS, each on amd64 and arm64, with | |
| 16 | + `checksums.txt` beside them. Unpack the one for your machine and put `codey` | |
| 17 | + somewhere on your `PATH`. The archive names carry no | |
| 18 | + version, so the latest one is always at the same address: | |
| 10 | 19 | |
| 11 | 20 | ```bash |
| 21 | + # linux or darwin, amd64 or arm64 | |
| 22 | + curl -L https://github.com/johannSo/codey/releases/latest/download/codey_linux_amd64.tar.gz | tar xz codey | |
| 23 | + ``` | |
| 24 | + | |
| 25 | + **With Go.** If you have Go installed, this builds the latest release and puts | |
| 26 | + it in `$(go env GOPATH)/bin`: | |
| 27 | + | |
| 28 | + ```bash | |
| 29 | + go install github.com/johannSo/codey/cmd/codey@latest | |
| 30 | + ``` | |
| 31 | + | |
| 32 | + `@latest` can be any tag, and `codey --version` reports the one you asked for. | |
| 33 | + The Go it needs is the one `go.mod` names; an older `go` command fetches that | |
| 34 | + toolchain by itself unless `GOTOOLCHAIN` says not to. | |
| 35 | + | |
| 36 | + **From source.** For working on Codey, or running a commit that is not | |
| 37 | + released yet: | |
| 38 | + | |
| 39 | + ```bash | |
| 40 | + git clone https://github.com/johannSo/codey | |
| 41 | + cd codey | |
| 12 | 42 | go build -o codey ./cmd/codey |
| 43 | + ``` | |
| 44 | + | |
| 45 | + A build from a checkout reports the version the source was last released as, | |
| 46 | + not the commit; `git log` is the better answer to "which one is this". The | |
| 47 | + examples in this README run it as `./codey`, from the directory it was built | |
| 48 | + in. Installed on your `PATH` it is just `codey`. | |
| 49 | + | |
| 50 | + ### macOS | |
| 51 | + | |
| 52 | + Release binaries are not signed or notarized. A download through a | |
| 53 | + browser is quarantined and Gatekeeper refuses to open it; `xattr -d | |
| 54 | + com.apple.quarantine codey` lifts that. The `curl` above does not quarantine | |
| 55 | + what it fetches, and neither does `go install`. | |
| 13 | 56 | |
| 57 | + ## Quick start | |
| 58 | + | |
| 59 | + ```bash | |
| 14 | 60 | ./codey -C /path/to/a/throwaway/clone # full-screen TUI |
| 15 | 61 | ./codey -C /path/to/repo -p "why does TestFoo fail?" # one prompt |
| 16 | 62 | ``` |
| @@ -1558,3 +1604,7 @@ is safe from the agent's goroutine. Approvals go out the same way and then | ||
| 1558 | 1604 | block the agent on a reply channel until a key arrives, and questions take the |
| 1559 | 1605 | same hatch with an answer on the way back. Those channels are buffered and the |
| 1560 | 1606 | wait honours the turn's context, so neither side can strand the other. |
| 1607 | + | |
| 1608 | + ## License | |
| 1609 | + | |
| 1610 | + MIT; see [LICENSE](LICENSE). | |