File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 11# Codiff
22
3- Codiff is a local PR viewer for reviewing staged and unstaged Git changes before
4- committing.
3+ Codiff is a beautiful, minimal, local diff viewer for reviewing staged and unstaged Git changes before committing.
54
6- ## Usage
5+ ## Why Codiff
6+
7+ - ** Fast Local Reviews:** See changes in any Git repository to review code before committing.
8+ - ** LLM Walkthroughs:** Run ` codiff -w ` to ask Codex to give your a review order and more context.
9+ - ** Inline Review Comments:** Comment directly on changed lines and copy all review comments as Markdown for follow-ups.
10+
11+ ## Download
12+
13+ Download the latest Codiff app from [ GitHub Releases] ( https://github.com/nkzw-tech/codiff/releases ) .
14+
15+ After installing the app, run ` Codiff > Install Terminal Helper ` to make the ` codiff ` command available in your shell.
16+
17+ ## Command Line
718
819``` bash
9- vp install
10- vp build
11- vpr codiff
20+ codiff
1221```
1322
1423Run it from any Git repository, or pass a path:
1524
1625``` bash
17- vpr codiff /path/to/repository
26+ codiff /path/to/repository
1827```
1928
20- The packaged CLI is named ` codiff ` . Launching it in multiple repositories opens
21- a separate native window for each repository.
29+ Start with an LLM-generated walkthrough order:
30+
31+ ``` bash
32+ codiff -w
33+ ```
2234
23- The renderer talks to a source-based repository API. The first UI uses the
24- ` working-tree ` source for staged and unstaged changes; the Electron bridge also
25- has commit history and commit-diff sources ready for the later history picker.
35+ Launching Codiff in multiple repositories opens a separate native window for each repository.
2636
2737## Development
2838
39+ ``` bash
40+ vp install
41+ vp build
42+ vpr codiff
43+ ```
44+
45+ For live development:
46+
2947``` bash
3048vpr dev
3149ELECTRON_RENDERER_URL=http://127.0.0.1:5173 vpr electron
You can’t perform that action at this time.
0 commit comments