Tutorial: your first commit

Install, stage, review and commit.

Requirements

Linux on x86_64 and a git repository with some history.

1. Install

$ curl -fsSL https://raw.githubusercontent.com/Lucas-BRT/pionus/main/install.sh | bash

The setup asks before anything that needs sudo, downloads the model and benchmarks your devices. The best shows with <- selected.

2. Stage your changes

git add src/retry.rs
# or, hunk by hunk
git add -p

-p keeps each commit focused, but any staging works.

It reads only what is staged. In a merge, revert or cherry-pick it keeps git's own message.

3. Preview the message (optional)

$ pionus
feat(retry): add a retry loop

This only prints a suggestion; nothing is committed.

4. Review and commit

┌ Commit message ──────────────────────┐
│feat(retry): add a retry loop         │
│                                      │
│Retries failed requests three times.  │
└──────────────────────────────────────┘
 qwen2.5-coder-1.5b on cpu · 1.6 s · from the model
┌ Staged: 2 files ─────────────────────┐
│ M src/retry.rs                       │
│ R src/http.rs -> src/net.rs          │
└──────────────────────────────────────┘
[Enter] commit  [e] edit, then commit  [a] another message  [q] cancel

Nothing is committed until you press a key:

Enter commits.
e edits the message, then commits.
a asks for another message.
q cancels.

5. Make it automatic (optional)

pionus hook install
# the editor opens with the message written
git commit

Edit the message as usual. pionus hook uninstall removes the hook.

6. When a message is wrong (optional)

pionus -v
# also print what was decided and why
pionus --trace bad.json
# record the generation, to report it

A trace holds your staged diff. Review it before sharing.