diff --git a/README.md b/README.md index d2c44aec56..f2ca263932 100644 --- a/README.md +++ b/README.md @@ -52,9 +52,16 @@ codeaf ``` The script puts the release binary for your platform in `~/.codeaf/bin`. To -build it yourself: `git clone`, `make build`, `bin/codeaf` -([guide](docs/GUIDE.md#install)). Release assets, checksums and version -pinning are on the [releases page](https://github.com/Agent-Field/codeaf/releases). +pin a version, give it a tag from the +[releases page](https://github.com/Agent-Field/codeaf/releases), where the +assets and checksums also live: + +```bash +curl -fsSL https://agentfield.ai/get/codeaf | VERSION= bash +``` + +To build it yourself: `git clone`, `make build`, `bin/codeaf` +([guide](docs/GUIDE.md#install)). On first start it asks for a key: OpenRouter, DeepSeek, GLM, Kimi, MiniMax or Qwen. Ollama needs none. diff --git a/docs/changes/unreleased/1103-readme-pin-example.md b/docs/changes/unreleased/1103-readme-pin-example.md new file mode 100644 index 0000000000..c3a9ac4522 --- /dev/null +++ b/docs/changes/unreleased/1103-readme-pin-example.md @@ -0,0 +1,13 @@ +--- +kind: fixed +title: The README shows how to pin a release version again +pr: 1103 +surface: [docs] +invalidates: + - "The README said only that version pinning is on the releases page. Its Install section now shows the pin inline: `curl -fsSL https://agentfield.ai/get/codeaf | VERSION= bash`." + - "`TestPublishedPinExamplesGiveVersionToBash` failed on a clean `dev` checkout after the README rewrite. It passes; every published install surface gives `VERSION` to bash, not to curl." +--- + +The pin goes after the pipe because `VERSION= curl ...` sets the variable +for curl and the install script never sees it; the release test guards every +page that shows an install line against that spelling.