Skip to content

docs(installation): add cargo install aube#9

Merged
jdx merged 1 commit intomainfrom
claude/add-cargo-install-method
Apr 18, 2026
Merged

docs(installation): add cargo install aube#9
jdx merged 1 commit intomainfrom
claude/add-cargo-install-method

Conversation

@jdx
Copy link
Copy Markdown
Contributor

@jdx jdx commented Apr 18, 2026

Summary

  • Document cargo install aube --locked as an install method on the installation page, between the recommended mise path and the from-source build.
  • README already defers to the docs page for "other install methods", so no README change.

Dependency

The crates.io page for aube doesn't exist yet — it'll be published on the first release-plz cycle after #7. Don't merge this PR until that release has landed, otherwise the docs page will link users to a 404.

Test plan

  • CI green (docs build + link check, if any).
  • After merge, verify cargo install aube --locked actually pulls from crates.io on a clean machine.

Note

Low Risk
Low risk documentation-only change; the main concern is user confusion if the crates.io package is not yet published when this ships.

Overview
Adds a new From crates.io section to docs/installation.md documenting installation via cargo install aube --locked, including a brief explanation of --locked and where the binary is installed.

Reviewed by Cursor Bugbot for commit 1faf187. Bugbot is set up for automated code reviews on this repo. Configure here.

Now that the crate is published to crates.io as `aube`, any user with
a Rust toolchain can install the released binary directly without
cloning the repo.
@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented Apr 18, 2026

Greptile Summary

This PR adds a cargo install aube --locked section to the installation docs, placed logically between the recommended mise path and the from-source build path. The new section is accurate: the command syntax is correct, the prerequisite (an existing Rust toolchain) is properly stated, the --locked flag is correctly explained as honoring the committed Cargo.lock, and the binary destination (~/.cargo/bin/aube) is right.

Notable:

  • The PR author explicitly flags a merge dependency: the crates.io package won't exist until after PR rename: aube-cli crate -> aube #7 lands and release-plz publishes a release. Merging before that point will point users at a 404. The author's test checklist already captures this, so no extra gate is needed — just respect the merge order.
  • No README change is needed because README.md already defers to the docs page for alternative install methods.
  • The from-source section (pre-existing) omits --locked, which is acceptable since building from a local checkout has different semantics than a registry install.

Confidence Score: 5/5

Safe to merge once the crates.io release from PR #7 is live — the doc content itself is accurate and well-structured.

Documentation-only change with correct content, clear prose, and appropriate placement. The one real risk (linking to a crates.io package that doesn't exist yet) is already explicitly called out in the PR description and test checklist — no surprises for the merger.

No files require special attention.

Important Files Changed

Filename Overview
docs/installation.md Adds a "From crates.io" section between the mise and from-source sections, documenting cargo install aube --locked with an accurate explanation of --locked and the install location.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Install aube] --> B{Have mise?}
    B -- Yes --> C["mise use -g aube\n(Recommended)"]
    B -- No --> D{Have Rust toolchain?}
    D -- Yes --> E["cargo install aube --locked\n(From crates.io) ← NEW"]
    D -- No --> F{Want to build from source?}
    F -- Yes --> G["git clone + cargo install --path crates/aube"]
    F -- No --> H[Install mise or Rust toolchain first]
    C --> I[aube --version]
    E --> I
    G --> I
Loading

Reviews (2): Last reviewed commit: "docs(installation): document `cargo inst..." | Re-trigger Greptile

@jdx jdx enabled auto-merge (squash) April 18, 2026 20:14
@jdx jdx merged commit b322ada into main Apr 18, 2026
17 checks passed
@jdx jdx deleted the claude/add-cargo-install-method branch April 18, 2026 20:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant