gn-cli 0.1.7

git-notes CLI — add, list, show, sync, resolve notes
Documentation

git-notes-cli (git-notes)

Command-line interface for git-notes — decentralized code comments that live inside Git forever.

Crates.io License

git-notes allows developers to add comments, reviews, and discussion threads directly to commits, files, and line numbers without altering Git commit history.


⚡ Installation

Install from crates.io via Cargo:

cargo install gn-cli --bin git-notes

Or download precompiled standalone binaries from GitHub Releases.


🚀 Commands

Add a Note

git-notes add -f src/main.rs -l 42 -m "Why is this O(n²)?"

Reply to a Thread

git-notes reply 72818dac -m "Refactored to HashMap lookup!"

Show Discussion Thread

git-notes show 72818dac --thread

List Notes

git-notes list --namespace comments
git-notes list --namespace review

Resolve / Approve

git-notes resolve 72818dac --status approved

Quickies & Single-Letter Abbreviations (gn)

Save keystrokes with fast, ergonomic quickies:

  • gn a -f file.rs -l 42 -m "..." — Quickie add note
  • gn l — List notes with compact numbered index [1], [2]
  • gn r 1 -m "Fixed!" — Reply directly using quick index number
  • gn ok 1 — Resolve / approve note by number
  • gn s — Interactive terminal arrow-key thread picker
  • gn d — View git diff with inline notes
  • gn b -f file.rs — Blame with inline notes annotations
  • gn doc — Doctor health check & stale-note detector

View & Customize Shortcuts

# View all abbreviations and keybindings
gn shortcuts

# Customize your own aliases
gn shortcuts --set c="add -m"

# Reset to defaults
gn shortcuts --reset

Export Notes

git-notes export --format markdown   # outputs NOTES.md
git-notes export --format json       # outputs notes.json
git-notes export --format html       # outputs index.html

🔗 Repository