detached 7141ebd

readme: drop private-repo install caveats

the repo will be public by the time anyone reads this, so the
GITHUB_TOKEN / GOPRIVATE scaffolding just adds noise. installers
and 'go install' were already coded to work unauthenticated on
public repos; no code changes needed.
commit
7141ebd45f7886c85b1a0ae29aef7894ecf0068c
author
patriceckhart · · 2026-04-18 09:51 UTC
parent
8e546bd
signature
unsigned
refs
tag: v0.0.6
1 file · +4 -23
M README.md +4 -23
@@ -12,20 +12,10 @@ yet another coding agent harness, lightweight and written (vibe-slopped) in go.
1212
1313 ## install
1414
15-> the repo and prebuilt artifacts are **private at the moment**. until they go public, every download command below needs a github personal access token (PAT) with `contents:read` scope on `patriceckhart/zot`. create one at <https://github.com/settings/tokens> and export it before running any installer:
16->
17-> ```bash
18-> export GITHUB_TOKEN=ghp_xxx
19-> ```
20->
21-> once the repo is public, the token becomes optional.
22-
2315 ### one-liner (macos + linux)
2416
2517 ```bash
26-curl -fsSL -H "Authorization: Bearer $GITHUB_TOKEN" \
27- https://raw.githubusercontent.com/patriceckhart/zot/main/install.sh \
28- | GITHUB_TOKEN=$GITHUB_TOKEN bash
18+curl -fsSL https://raw.githubusercontent.com/patriceckhart/zot/main/install.sh | bash
2919 ```
3020
3121 detects your os/arch, downloads the latest release from github, verifies the sha256 against the release's `checksums.txt`, extracts the binary, and drops it in `/usr/local/bin`, `~/.local/bin`, or `~/bin` — whichever is writable first. pass a version or prefix to pin:
@@ -37,34 +27,25 @@ curl -fsSL https://raw.githubusercontent.com/patriceckhart/zot/main/install.sh |
3727 ### one-liner (windows, powershell)
3828
3929 ```powershell
40-$env:GITHUB_TOKEN = "ghp_xxx"
41-$h = @{ Authorization = "Bearer $env:GITHUB_TOKEN" }
42-(Invoke-WebRequest -UseBasicParsing -Headers $h `
43- https://raw.githubusercontent.com/patriceckhart/zot/main/install.ps1).Content | iex
30+iwr -useb https://raw.githubusercontent.com/patriceckhart/zot/main/install.ps1 | iex
4431 ```
4532
4633 drops `zot.exe` into `$HOME\bin` and adds it to the user PATH if missing. open a fresh terminal afterwards.
4734
4835 ### homebrew (macos + linux)
4936
50-available once the repo is public. the tap lives at `patriceckhart/homebrew-tap`:
51-
5237 ```bash
5338 brew install patriceckhart/tap/zot
5439 ```
5540
56-### go install
41+the tap lives at `patriceckhart/homebrew-tap`.
5742
58-while the repo is private, `go install` needs to bypass the public go module proxy:
43+### go install
5944
6045 ```bash
61-export GOPRIVATE=github.com/patriceckhart/*
62-export GIT_TERMINAL_PROMPT=0
6346 go install github.com/patriceckhart/zot/cmd/zot@latest
6447 ```
6548
66-your git must already be authenticated to github (ssh key or https PAT in `~/.netrc`). once the repo is public, `go install github.com/patriceckhart/zot/cmd/zot@latest` is enough.
67-
6849 ### from source
6950
7051 ```bash
@@ -12,20 +12,10 @@ yet another coding agent harness, lightweight and written (vibe-slopped) in go.
12 12
13 ## install13 ## install
14 14
15-> the repo and prebuilt artifacts are **private at the moment**. until they go public, every download command below needs a github personal access token (PAT) with `contents:read` scope on `patriceckhart/zot`. create one at <https://github.com/settings/tokens> and export it before running any installer:
16->
17-> ```bash
18-> export GITHUB_TOKEN=ghp_xxx
19-> ```
20->
21-> once the repo is public, the token becomes optional.
22-
23 ### one-liner (macos + linux)15 ### one-liner (macos + linux)
24 16
25 ```bash17 ```bash
26-curl -fsSL -H "Authorization: Bearer $GITHUB_TOKEN" \18+curl -fsSL https://raw.githubusercontent.com/patriceckhart/zot/main/install.sh | bash
27- https://raw.githubusercontent.com/patriceckhart/zot/main/install.sh \
28- | GITHUB_TOKEN=$GITHUB_TOKEN bash
29 ```19 ```
30 20
31 detects your os/arch, downloads the latest release from github, verifies the sha256 against the release's `checksums.txt`, extracts the binary, and drops it in `/usr/local/bin`, `~/.local/bin`, or `~/bin` — whichever is writable first. pass a version or prefix to pin:21 detects your os/arch, downloads the latest release from github, verifies the sha256 against the release's `checksums.txt`, extracts the binary, and drops it in `/usr/local/bin`, `~/.local/bin`, or `~/bin` — whichever is writable first. pass a version or prefix to pin:
@@ -37,34 +27,25 @@ curl -fsSL https://raw.githubusercontent.com/patriceckhart/zot/main/install.sh |
37 ### one-liner (windows, powershell)27 ### one-liner (windows, powershell)
38 28
39 ```powershell29 ```powershell
40-$env:GITHUB_TOKEN = "ghp_xxx"30+iwr -useb https://raw.githubusercontent.com/patriceckhart/zot/main/install.ps1 | iex
41-$h = @{ Authorization = "Bearer $env:GITHUB_TOKEN" }
42-(Invoke-WebRequest -UseBasicParsing -Headers $h `
43- https://raw.githubusercontent.com/patriceckhart/zot/main/install.ps1).Content | iex
44 ```31 ```
45 32
46 drops `zot.exe` into `$HOME\bin` and adds it to the user PATH if missing. open a fresh terminal afterwards.33 drops `zot.exe` into `$HOME\bin` and adds it to the user PATH if missing. open a fresh terminal afterwards.
47 34
48 ### homebrew (macos + linux)35 ### homebrew (macos + linux)
49 36
50-available once the repo is public. the tap lives at `patriceckhart/homebrew-tap`:
51-
52 ```bash37 ```bash
53 brew install patriceckhart/tap/zot38 brew install patriceckhart/tap/zot
54 ```39 ```
55 40
56-### go install41+the tap lives at `patriceckhart/homebrew-tap`.
57 42
58-while the repo is private, `go install` needs to bypass the public go module proxy:43+### go install
59 44
60 ```bash45 ```bash
61-export GOPRIVATE=github.com/patriceckhart/*
62-export GIT_TERMINAL_PROMPT=0
63 go install github.com/patriceckhart/zot/cmd/zot@latest46 go install github.com/patriceckhart/zot/cmd/zot@latest
64 ```47 ```
65 48
66-your git must already be authenticated to github (ssh key or https PAT in `~/.netrc`). once the repo is public, `go install github.com/patriceckhart/zot/cmd/zot@latest` is enough.
67-
68 ### from source49 ### from source
69 50
70 ```bash51 ```bash

Keyboard shortcuts

Single-key shortcuts are on. ctrl k and esc work whatever this says.

ctrl k :
go to a section, branch, tag, file or repository
?
this list
j k
move the row cursor down / up
enter
open the row under the cursor; on Files, a directory opens or closes in place
↑ ↓ ← → home end
in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
l h
on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls
g g G
first / last row
/
filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
b
switch branch or tag
g s g f g c g b g m g i g r g a
tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
g h
home
w
wide mode: use the whole width of the screen, or not (remembered)
y
copy a permalink pinned to the commit
d u x
diff: split / unified / collapse or expand all
e E
diff: the whole file in view / every file, with the lines the hunks hide
n
merge request: next note in the diff
esc
close a dialog, leave a field

Branches 1

Tags 476

↑↓ moveenter openesc close