Skip to content

docs: align README install section with the landing page #137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jkyberneees merged 2 commits into from
Sep 27, 2026
Merged

docs: align README install section with the landing page #137

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ae969e
docs: align README install section with the landing page
jkyberneees Sep 27, 2026
4006846
docs: correct installer claims in the README install section
jkyberneees Sep 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 12 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,26 +65,24 @@ bodek reuses that exact protocol from the terminal, which means:

## Install

**Prerequisite:** bodek is only the front-end — you also need the `odek`
engine. See [odek's install instructions](https://github.com/BackendStack21/odek)
(provider env key such as `DEEPSEEK_API_KEY` / `ZAI_API_KEY` — see odek's [PROVIDERS.md](https://github.com/BackendStack21/odek/blob/main/docs/PROVIDERS.md)).

### Prebuilt binaries

Download the latest compiled binary from the
[releases page](https://github.com/BackendStack21/bodek/releases) — archives
are published for Linux, macOS, and Windows (amd64 & arm64), with
`checksums.txt` for verification.

One-liner for Linux / macOS (checksum-verified, installs into `~/.local/bin`):

One-liner for macOS & Linux (checksum-verified, installs into `/usr/local/bin`
or `~/.local/bin` when that is not writable).
It offers to set up the `odek` engine, which bodek needs on `PATH` (piped
installs default to No — rerun with `--with-odek` to install it
unconditionally):

```bash
curl -fsSL https://bodek.21no.de/install.sh | sh
```

You still need a provider API key for the engine (`DEEPSEEK_API_KEY` /
`ZAI_API_KEY` — see odek's [PROVIDERS.md](https://github.com/BackendStack21/odek/blob/main/docs/PROVIDERS.md)
and its [install instructions](https://github.com/BackendStack21/odek)).
Later, `bodek upgrade` downloads and installs the latest release the same way.

On Windows, download the `windows_amd64` (or `arm64`) `.zip` from the
releases page and put `bodek.exe` on your `PATH`.
[releases page](https://github.com/BackendStack21/bodek/releases) and put
`bodek.exe` on your `PATH`.

### From source

Expand Down
Loading