repomind 0.8.0 → 0.9.1
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 +101 -0
- package/dist/index.js +49789 -2628
- package/package.json +11 -12
package/README.md
ADDED
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
<!-- generated-by: gsd-doc-writer -->
|
|
2
|
+
# repomind
|
|
3
|
+
|
|
4
|
+
AI-powered git commit messages and repository insights — the primary developer-facing tool for RepoMind, used daily in the terminal.
|
|
5
|
+
|
|
6
|
+
Part of the [repomind monorepo](../../README.md).
|
|
7
|
+
|
|
8
|
+
## Installation
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
bun add -g repomind
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Quick Start
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
# 1. Authenticate
|
|
18
|
+
repomind login
|
|
19
|
+
|
|
20
|
+
# 2. Stage your changes
|
|
21
|
+
git add .
|
|
22
|
+
|
|
23
|
+
# 3. Generate a commit message
|
|
24
|
+
repomind commit
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Commands
|
|
28
|
+
|
|
29
|
+
| Command | Description |
|
|
30
|
+
|---------|-------------|
|
|
31
|
+
| `repomind commit` | Generates a commit message from `git diff --staged` |
|
|
32
|
+
| `repomind split [--all]` | Analyzes staged changes and splits them into atomic commits |
|
|
33
|
+
| `repomind pr` | Generates a PR description from the diff between branches |
|
|
34
|
+
| `repomind login [--token <token>]` | Authenticates via Device Flow (code + browser) or Personal Access Token |
|
|
35
|
+
| `repomind logout` | Ends the current session and removes the local token |
|
|
36
|
+
| `repomind whoami` | Displays the currently authenticated user |
|
|
37
|
+
| `repomind help` | Displays help for available commands |
|
|
38
|
+
|
|
39
|
+
### Flags
|
|
40
|
+
|
|
41
|
+
Each command accepts:
|
|
42
|
+
|
|
43
|
+
- `--verbose` / `-v` — Show error details
|
|
44
|
+
- `--help` / `-h` — Show command help
|
|
45
|
+
- `--version` / `-V` — Show CLI version (top-level flag)
|
|
46
|
+
|
|
47
|
+
`repomind split` also accepts:
|
|
48
|
+
|
|
49
|
+
- `--all` — Include unstaged and untracked changes (default: staged only)
|
|
50
|
+
|
|
51
|
+
## Usage Examples
|
|
52
|
+
|
|
53
|
+
**Generate a commit message from staged changes:**
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
git add src/feature.ts
|
|
57
|
+
repomind commit
|
|
58
|
+
# → feat(feature): add new feature logic
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
**Split staged changes into atomic commits:**
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
git add .
|
|
65
|
+
repomind split
|
|
66
|
+
# Analyzes diff → proposes multiple atomic commits → confirms each
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
**Generate a PR description:**
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
repomind pr
|
|
73
|
+
# Compares HEAD with base branch (main/master) → generates description
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## Development
|
|
77
|
+
|
|
78
|
+
**Prerequisites:** Bun >= 1.0.0
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
# Install dependencies (from monorepo root)
|
|
82
|
+
bun install
|
|
83
|
+
|
|
84
|
+
# Run in development mode
|
|
85
|
+
bun --cwd apps/cli dev
|
|
86
|
+
|
|
87
|
+
# Build
|
|
88
|
+
bun --cwd apps/cli run build
|
|
89
|
+
|
|
90
|
+
# Typecheck
|
|
91
|
+
bun --cwd apps/cli run typecheck
|
|
92
|
+
|
|
93
|
+
# Tests
|
|
94
|
+
bun --cwd apps/cli test
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
Environment: copy `.env.dist` to `.env.local` inside `apps/cli/` and adjust values as needed.
|
|
98
|
+
|
|
99
|
+
## License
|
|
100
|
+
|
|
101
|
+
MIT
|