Skip to content

docs: align GETTING_STARTED.md install commands with the landing page #274

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 GETTING_STARTED.md install commands with the landing page #274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3985013
docs: lead GETTING_STARTED.md with the installer used on the landing …
jkyberneees Sep 27, 2026
e8b4b09
docs: fix installer target dir and Go version claims
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
53 changes: 28 additions & 25 deletions GETTING_STARTED.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,40 +12,28 @@ odek is a single static Go binary (<15 MB, instant startup). No Python, no Node,
|---|---|
| macOS or Linux | Prebuilt binaries, amd64 & arm64. Windows: build from source with Go |
| A z.ai API key | From the [GLM Coding Plan](https://z.ai/subscribe) subscription or pay-as-you-go. Create/manage keys at [z.ai Open Platform](https://z.ai/manage-apikey/apikey-list) |
| Go ≥ 1.25.13 | *Only* if installing from source. Not needed for prebuilt binaries |
| Go ≥ 1.27 | *Only* if installing from source. Not needed for prebuilt binaries |
| Docker | *Optional* — enables the default-on sandbox. Skip it with `ODEK_NO_SANDBOX=1` (see [Step 4](#4-sandbox-docker-optional)) |

---

## 1. Install odek

**From a release tag using source** (requires Go and Git):

```bash
TAG=$(git ls-remote --tags --sort=-v:refname \
https://github.com/BackendStack21/odek.git \
| awk '!/\^\{\}$/ {sub("refs/tags/", "", $2); print $2; exit}')
TMP=$(mktemp -d)
git clone --depth 1 --branch "${TAG}" \
https://github.com/BackendStack21/odek.git "${TMP}/odek"
(cd "${TMP}/odek" && go install -ldflags "-X main.version=${TAG}" ./cmd/odek)
rm -rf "${TMP}"
export PATH="$(go env GOPATH)/bin:$PATH"
```

Do not use `go install …@latest`: Go ignores v2 tags for this repository's
historical v1 module path and would install an older v1 release.

**Or grab a prebuilt binary** — one line (verifies SHA-256, installs to
`~/.local/bin` or `/usr/local/bin`):
**One line** — downloads the Linux or macOS (amd64 & arm64) binary, verifies
the SHA-256 against the release `checksums.txt`, and installs to
`/usr/local/bin` (or `~/.local/bin` when `/usr/local/bin` is not writable):

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

Prefer manual steps? Binaries for Linux and macOS (amd64 & arm64) plus a
`checksums.txt` for verification live on the
[releases page](https://github.com/BackendStack21/odek/releases):
Later, `odek upgrade` self-updates from GitHub Releases the same way
(SHA-256 verified). The script is
[readable here](https://github.com/BackendStack21/odek/blob/main/docs/install.sh)
— pipe-to-sh should always be a choice, not a habit.

**Prefer manual steps?** Binaries plus a `checksums.txt` for verification
live on the [releases page](https://github.com/BackendStack21/odek/releases):

```bash
OS=$(uname -s | tr '[:upper:]' '[:lower:]')
Expand Down Expand Up @@ -73,8 +61,23 @@ Verify:
odek version
```

Later: `odek upgrade` self-updates from GitHub Releases (SHA-256 verified) —
see [Keeping things up to date](#keeping-things-up-to-date).
**Building from source instead** (requires Go ≥ 1.27 and Git) — clone the
latest release tag and install with the version pinned:

```bash
TAG=$(git ls-remote --tags --sort=-v:refname \
https://github.com/BackendStack21/odek.git \
| awk '!/\^\{\}$/ {sub("refs/tags/", "", $2); print $2; exit}')
TMP=$(mktemp -d)
git clone --depth 1 --branch "${TAG}" \
https://github.com/BackendStack21/odek.git "${TMP}/odek"
(cd "${TMP}/odek" && go install -ldflags "-X main.version=${TAG}" ./cmd/odek)
rm -rf "${TMP}"
export PATH="$(go env GOPATH)/bin:$PATH"
```

Do not use `go install …@latest`: Go ignores v2 tags for this repository's
historical v1 module path and would install an older v1 release.

---

Expand Down
4 changes: 2 additions & 2 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
"name": "How do I install odek?",
"acceptedAnswer": {
"@type": "Answer",
"text": "Run: curl -fsSL https://odek.21no.de/install.sh | sh — it downloads the Linux or macOS binary, verifies the SHA-256 against the release checksums.txt, and installs to ~/.local/bin. Do not use go install …@latest — Go ignores v2 tags for this module path and would install an older v1 release. To build from source, clone the latest release tag and go install with -ldflags that pin that tag."
"text": "Run: curl -fsSL https://odek.21no.de/install.sh | sh — it downloads the Linux or macOS binary, verifies the SHA-256 against the release checksums.txt, and installs to /usr/local/bin (or ~/.local/bin when /usr/local/bin is not writable). Do not use go install …@latest — Go ignores v2 tags for this module path and would install an older v1 release. To build from source, clone the latest release tag and go install with -ldflags that pin that tag."
}
},
{
Expand Down Expand Up @@ -243,7 +243,7 @@ <h2 id="need-h" class="sr-only">What you need</h2>
</td>
</tr>
<tr>
<td>Go ≥ 1.25.13</td>
<td>Go ≥ 1.27</td>
<td>Only if you build from source. Not needed for the prebuilt binary.</td>
</tr>
<tr>
Expand Down
Loading