@jxtools/visualgit 1.0.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -46
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,67 +2,34 @@
|
|
|
2
2
|
|
|
3
3
|
Terminal-style git diff viewer with AI-powered explanations.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## Quick Start
|
|
5
|
+
## Install
|
|
8
6
|
|
|
9
7
|
```bash
|
|
10
|
-
|
|
8
|
+
npm install -g @jxtools/visualgit
|
|
11
9
|
```
|
|
12
10
|
|
|
13
|
-
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
Navigate to any git repository and run:
|
|
14
14
|
|
|
15
15
|
```bash
|
|
16
|
-
npm install -g visualgit
|
|
17
16
|
visualgit
|
|
18
17
|
```
|
|
19
18
|
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
- Detects your current branch and compares it against the base branch (upstream, develop, main, or master)
|
|
23
|
-
- Displays a colored diff with additions/deletions in a dark terminal-style UI
|
|
24
|
-
- Shows ahead/behind commit counts
|
|
25
|
-
- Provides on-demand AI analysis of your changes using Claude CLI or OpenAI
|
|
26
|
-
|
|
27
|
-
## AI Analysis
|
|
28
|
-
|
|
29
|
-
The AI panel lets you get explanations of your diff on demand. Click **"Get AI Analysis"** to trigger it - it does not run automatically.
|
|
30
|
-
|
|
31
|
-
**Supported providers:**
|
|
32
|
-
|
|
33
|
-
- **Claude** - Uses your existing `claude` CLI login (no API key needed)
|
|
34
|
-
- **OpenAI** - Uses your existing `openai` CLI login
|
|
35
|
-
|
|
36
|
-
Toggle between providers using the dropdown in the AI panel.
|
|
37
|
-
|
|
38
|
-
## Development
|
|
39
|
-
|
|
40
|
-
```bash
|
|
41
|
-
# Install dependencies
|
|
42
|
-
npm install
|
|
43
|
-
|
|
44
|
-
# Run frontend dev server
|
|
45
|
-
npm run dev
|
|
46
|
-
|
|
47
|
-
# Run backend dev server (separate terminal)
|
|
48
|
-
npm run dev:server
|
|
49
|
-
|
|
50
|
-
# Run tests
|
|
51
|
-
npm test
|
|
52
|
-
```
|
|
19
|
+
This opens a browser window with a visual diff between your current branch and its base branch.
|
|
53
20
|
|
|
54
|
-
##
|
|
21
|
+
## Features
|
|
55
22
|
|
|
56
|
-
-
|
|
57
|
-
-
|
|
58
|
-
-
|
|
59
|
-
-
|
|
23
|
+
- Colored diff viewer with file tree navigation
|
|
24
|
+
- Collapsible file sections with viewed tracking
|
|
25
|
+
- AI analysis of your changes on demand (Claude or OpenAI)
|
|
26
|
+
- Resizable panels and dark terminal-style UI
|
|
60
27
|
|
|
61
28
|
## Requirements
|
|
62
29
|
|
|
63
30
|
- Node.js 18+
|
|
64
|
-
-
|
|
65
|
-
- Claude CLI or OpenAI CLI installed
|
|
31
|
+
- Must be run inside a git repository
|
|
32
|
+
- For AI features: Claude CLI or OpenAI CLI installed
|
|
66
33
|
|
|
67
34
|
## License
|
|
68
35
|
|