Skip to content

docs(install): git tag primary until crates.io smoke #5

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
makefunstuff merged 4 commits into from
Sep 22, 2026
Merged

docs(install): git tag primary until crates.io smoke #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
63a4b8c
docs(install): git tag primary until crates.io smoke PASSes
makefunstuff Sep 22, 2026
8586d41
docs(cheatsheet): git tag install primary until crates.io live
makefunstuff Sep 22, 2026
ff56fb6
docs(install): crates.io clank-cli-app primary after smoke PASS
makefunstuff Sep 22, 2026
2b3dc69
docs(cheatsheet): crates.io primary; git tag fallback
makefunstuff Sep 22, 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
2 changes: 1 addition & 1 deletion CHEATSHEET.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ on a laptop-only built-in default — point at your OpenAI-compatible server.
## Install

```sh
cargo install clank-cli-app --locked # package name; runs as clank / clank-jev
cargo install clank-cli-app --locked # package ≠ binary → clank / clank-jev
# fallback: cargo install --locked --git https://github.com/makefunstuff/clank --tag v0.1.0
```

Expand Down
21 changes: 11 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,22 @@ context, `--each`, schema through `jq`, failure with reason and `exit 1`.
## Install

**Install line 1:** package `clank-cli-app` → binaries `clank` and `clank-jev`
(package ≠ binary). The crates.io crate named `clank` is unrelated — never
`cargo install clank`. Six direct dependencies, and nothing system-provided
beyond a C compiler (`ring`, for TLS; no OpenSSL to find).
(package ≠ binary). Never `cargo install clank` — that crates.io name is an
unrelated project.

```sh
cargo install clank-cli-app --locked # -> ~/.cargo/bin/clank and clank-jev
```

Git fallback (pin a tag):

```sh
cargo install --locked --git https://github.com/makefunstuff/clank --tag v0.1.0
```

Six direct dependencies, and nothing system-provided beyond a C compiler
(`ring`, for TLS; no OpenSSL to find).

Prebuilt archives are attached to each
[release](https://github.com/makefunstuff/clank/releases) — linux x86_64, macOS
arm64 and macOS x86_64 — each holding both binaries, this README, the LICENSE,
Expand All @@ -49,13 +57,6 @@ sha256sum -c clank-*.tar.gz.sha256 # macOS: shasum -a 256 -c
tar xzf clank-*.tar.gz
```

Until the first crates.io publish (manual Actions dispatch with
`publish_crates_io` — not auto on tag), or as a pinable fallback:

```sh
cargo install --locked --git https://github.com/makefunstuff/clank --tag v0.1.0
```

`--locked` holds the dependency graph to the committed `Cargo.lock`; `--tag` /
`--rev <sha>` pins clank itself. That directory is on `PATH` if you have
installed anything with cargo before. From a checkout instead — `src/` is 2.8k
Expand Down
Loading