Skip to content

docs: point install instructions at install.sh one-liners #120

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 1 commit into from
Sep 13, 2026
Merged

docs: point install instructions at install.sh one-liners #120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 8 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ behaviour (tools, danger gating, sandbox, skills, memory, sessions) comes from

```bash
# 1 · Install the engine and the TUI
go install github.com/BackendStack21/odek/cmd/odek@latest
go install github.com/BackendStack21/bodek/cmd/bodek@latest
curl -fsSL https://odek.21no.de/install.sh | sh
curl -fsSL https://bodek.21no.de/install.sh | sh

# 2 · Provide an LLM key (odek v2: provider env key)
export DEEPSEEK_API_KEY=<your-key>
Expand Down Expand Up @@ -76,15 +76,11 @@ Download the latest compiled binary from the
are published for Linux, macOS, and Windows (amd64 & arm64), with
`checksums.txt` for verification.

One-liner for Linux / macOS (resolves the latest asset for your platform and
installs into `~/.local/bin`):
One-liner for Linux / macOS (checksum-verified, installs into `~/.local/bin`):


```bash
OS=$(uname -s | tr '[:upper:]' '[:lower:]')
ARCH=$(uname -m); [ "$ARCH" = "x86_64" ] && ARCH=amd64
URL=$(curl -fsSL https://api.github.com/repos/BackendStack21/bodek/releases/latest \
| grep browser_download_url | grep "${OS}_${ARCH}" | cut -d '"' -f 4)
curl -fsSL "$URL" | tar -xz bodek && install -m 755 bodek ~/.local/bin/
curl -fsSL https://bodek.21no.de/install.sh | sh
```

On Windows, download the `windows_amd64` (or `arm64`) `.zip` from the
Expand All @@ -93,8 +89,9 @@ releases page and put `bodek.exe` on your `PATH`.
### From source

```bash
# Install odek (the engine) and bodek (the TUI)
go install github.com/BackendStack21/odek/cmd/odek@latest
# odek from source: clone the latest release tag and build — never
# 'go install ...odek@latest' (Go ignores v2 tags there; stale v1 result).
# bodek from source (v0 module, @latest is fine):
go install github.com/BackendStack21/bodek/cmd/bodek@latest

# Provide an LLM key (odek v2: provider env key)
Expand Down
5 changes: 3 additions & 2 deletions docs/install.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ install_odek() {

Odek is installed. Next, set up your provider:

1. odek init # creates ~/.odek/config.json
1. odek init --global # creates ~/.odek/config.json
2. Add your provider API key, e.g.:
"providers": { "openai": { "apiKey": "sk-..." } }
Full guide: https://github.com/BackendStack21/odek/blob/main/GETTING_STARTED.md
Expand Down Expand Up @@ -156,7 +156,8 @@ maybe_install_odek() {
case "$answer" in
y|Y|yes|YES) install_odek ;;
*) warn "skipping odek — bodek needs a running 'odek serve' to connect to.
To install it later, rerun with: sh install.sh --with-odek" ;;
To install it later: curl -fsSL https://odek.21no.de/install.sh | sh
(or rerun this installer with: sh install.sh --with-odek)" ;;
esac
}

Expand Down