git404hub

what is annotui fr?

osolmaz/annotui — explained in plain English

Analysis updated 2026-05-18

2RustAudience · developerComplexity · 1/5LicenseSetup · easy

tl;dr

annotui is a mouse-driven terminal tool for reviewing and commenting on files or piped text, similar to a GitHub pull request review, saved as Markdown or JSON.

vibe map

mindmap
  root((annotui))
    What it does
      Mouse driven text review
      Inline comment editor
      GitHub style review surface
    Tech stack
      Rust
      cargo
    Use cases
      Review git diffs
      Comment on files
      Save and resume reviews
    Output formats
      Comments only
      Full quoted
      JSON sidecar

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

what do people make with this?

VIBE 1

Review a git diff piped from the command line by dragging over lines and adding comments.

VIBE 2

Comment on a document or code file in the terminal and export the notes as Markdown.

VIBE 3

Save a review as a JSON sidecar file so it can be reopened and continued later.

VIBE 4

Do a mouse-driven code review entirely inside a terminal without leaving the command line.

what's the stack?

Rustcargo

how it stacks up fr

osolmaz/annotui132ikl/game1lystore/pay-dcp
Stars222
LanguageRustRustRust
Last pushed2020-12-30
MaintenanceDormant
Setup difficultyeasymoderatemoderate
Complexity1/52/53/5
Audiencedevelopergeneraldeveloper

Figures from each repo's GitHub metadata at analysis time.

how do i run it?

Difficulty · easy time til it works · 5min

Install with a single cargo install command, requires Rust 1.88 or newer and a Unix terminal.

MIT license, use freely including commercially as long as the copyright notice is kept.

in plain english

annotui is a terminal application for adding comments to a file or to text piped in from another command, built around using the mouse rather than typing commands to select what you want to comment on. It turns whatever text you give it into a read-only buffer that behaves like a GitHub pull request review: you drag across the lines you care about, an inline editor pops up, and you type your note. You can run it directly on a file, such as annotui README.md, or pipe text into it, such as git diff piped into annotui, or pass text directly with a buffer flag. The tool never changes the original text you are reviewing. Existing comments stay visible under the lines they refer to, and you can jump between them with the arrow keys or by clicking, then press Enter to edit one. Once you are done reviewing, annotui writes your comments out in one of a few formats. The default format writes only the quoted lines you commented on along with your notes. A full format quotes the entire input with comments inserted after the ranges they belong to. A JSON format writes a versioned model of the line ranges and comments, which is useful for saving your work and continuing it later. When loading a saved JSON review, annotui checks a hash of the original source and refuses to reapply old comments if the underlying text has changed, so comments cannot silently end up attached to the wrong lines. Controls cover both mouse and keyboard: dragging selects a range to comment on, clicking opens an existing comment, and keys like j, k, and the arrow keys move between comments, with dedicated keys to edit, delete, or jump to the next comment. A no-mouse flag is available for terminals where mouse capture is not wanted. Installation is a single cargo install command, since it is written in Rust and published on crates.io. It requires a Unix terminal and UTF-8 input. The project is released under the MIT license.

prompts (copy fr)

prompt 1
Show me how to pipe a git diff into annotui and export the comments as Markdown.
prompt 2
Explain the difference between annotui's comments, full, and json output formats.
prompt 3
How do I save and reload a review using annotui's --comments sidecar file?
prompt 4
Walk me through annotui's keyboard shortcuts for jumping between comments.

Frequently asked questions

what is annotui fr?

annotui is a mouse-driven terminal tool for reviewing and commenting on files or piped text, similar to a GitHub pull request review, saved as Markdown or JSON.

What language is annotui written in?

Mainly Rust. The stack also includes Rust, cargo.

What license does annotui use?

MIT license, use freely including commercially as long as the copyright notice is kept.

How hard is annotui to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is annotui for?

Mainly developer.

peek the repo → explain another one

This repo across BitVibe Labs

double-check against the repo, no cap.