Skip to content

Offer cargo install now that the crates are published #6

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

Closed
Zenofex wants to merge 1 commit into from
Closed

Offer cargo install now that the crates are published #6

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
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,10 @@ docker run --rm -i ghcr.io/bootintel/cli:latest scan - < boot.log
# Nix flake (in-repo):
nix run github:bootintel/cli -- version

# Cargo (from source):
# Cargo (from crates.io):
cargo install bootintel-cli

# Cargo (from a source checkout):
cargo install --path crates/cli --features tui
```

Expand All @@ -112,7 +115,7 @@ Pin to a release tag (`@cli-v0.4.0`) or a commit SHA — **never `@main`** (a co

**Homebrew:** the formula template lives at `packaging/homebrew/bootintel.rb`. A public `bootintel/homebrew-tap` for `brew install bootintel` is planned.

**crates.io:** `cargo install bootintel-cli` is not available yet. The crates are publishable and the release workflow has the job wired, pending a registry token. See [docs/releasing.md](docs/releasing.md).
**crates.io:** `cargo install bootintel-cli` installs the latest published release. Note that this builds from source, so it needs a Rust toolchain and takes a few minutes; the one-liner above drops a prebuilt binary in seconds. See [docs/releasing.md](docs/releasing.md) for how releases are cut.

**Windows:** the one-liner above downloads + SHA256-verifies the latest release, extracts `bootintel.exe` into `$env:USERPROFILE\.local\bin`, and prints a `setx PATH` line if that dir isn't already on your PATH. Override with `$env:BOOTINTEL_VERSION` / `$env:BOOTINTEL_INSTALL_DIR`, or use `$env:BOOTINTEL_TARBALL` for offline installs. Currently x86_64 only — ARM64 users need `cargo install --path crates/cli --features tui`.

Expand Down
7 changes: 4 additions & 3 deletions docs/releasing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ cargo publish -p bootintel-detectors
cargo publish -p bootintel-cli
```

After the first successful publish, update the Install section of `README.md`
to offer `cargo install bootintel-cli` instead of the from-source line. Do not
add it before then.
The README's Install section offers `cargo install bootintel-cli` as of
0.4.1, the first published version. Keep the caveat that it builds from
source and therefore needs a toolchain: the install one-liner is faster
for anyone who just wants the binary.
Loading