contribute-now 0.6.2-dev.3d69403 → 0.6.2-dev.560304f
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 +29 -7
- package/dist/index.js +4078 -888
- package/package.json +3 -1
package/README.md
CHANGED
|
@@ -83,7 +83,7 @@ cn setup # shortest — even shorter than git!
|
|
|
83
83
|
|
|
84
84
|
### `contrib setup`
|
|
85
85
|
|
|
86
|
-
Interactive setup wizard. Configures your repo's workflow mode, commit convention, your role,
|
|
86
|
+
Interactive setup wizard. Configures your repo's workflow mode, commit convention, your role, branch/remote names, and AI provider settings. Writes local config to `.git/contribute-now/config.json` by default.
|
|
87
87
|
|
|
88
88
|
```bash
|
|
89
89
|
contrib setup
|
|
@@ -92,9 +92,29 @@ contrib setup
|
|
|
92
92
|
Steps:
|
|
93
93
|
1. Choose **workflow mode** — Clean Flow, GitHub Flow, or Git Flow
|
|
94
94
|
2. Choose **commit convention** — Clean Commit, Conventional Commits, or None
|
|
95
|
-
3.
|
|
96
|
-
4.
|
|
97
|
-
5.
|
|
95
|
+
3. Choose whether **AI features** should be enabled for this repo
|
|
96
|
+
4. If using **Ollama Cloud**, pick from the available models returned by your API key, or enter one manually
|
|
97
|
+
5. Detect remotes and auto-detect your **role** (maintainer or contributor)
|
|
98
|
+
6. Confirm branch and remote names
|
|
99
|
+
7. Write `.git/contribute-now/config.json` (or update `.contributerc.json` if that legacy file is still the active source)
|
|
100
|
+
|
|
101
|
+
If you want to disable AI completely for a repo, run `contrib setup` and turn AI off, or set `"aiEnabled": false` in the active config file. Per-command `--no-ai` flags still work as one-off overrides when AI is enabled globally.
|
|
102
|
+
|
|
103
|
+
If you want a cleaner output once you're familiar with the CLI, set `"showTips": false` in the active config file to hide the beginner quick guides and loading tips.
|
|
104
|
+
|
|
105
|
+
---
|
|
106
|
+
|
|
107
|
+
### `contrib config`
|
|
108
|
+
|
|
109
|
+
Inspect the active repo config or edit it without rerunning the full setup flow.
|
|
110
|
+
|
|
111
|
+
```bash
|
|
112
|
+
contrib config
|
|
113
|
+
contrib config --json
|
|
114
|
+
contrib config --edit
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
Use `--edit` to update workflow settings, branch names, commit convention, AI provider details, the stored Ollama Cloud API key, and to choose from the currently available Ollama Cloud models. Ollama Cloud uses the built-in default host and does not ask for a custom host URL.
|
|
98
118
|
|
|
99
119
|
---
|
|
100
120
|
|
|
@@ -146,6 +166,8 @@ After the AI generates a message, you can **accept**, **edit**, **regenerate**,
|
|
|
146
166
|
|
|
147
167
|
**Group commit mode** (`--group`): AI analyzes all staged and unstaged changes, groups related files into logical atomic commits, and generates a commit message for each group. Great for splitting a large set of changes into clean, reviewable commits.
|
|
148
168
|
|
|
169
|
+
If `aiEnabled` is set to `false` in `.contributerc.json`, `contrib commit` stays manual and `--group` is unavailable.
|
|
170
|
+
|
|
149
171
|
---
|
|
150
172
|
|
|
151
173
|
### `contrib update`
|
|
@@ -205,7 +227,7 @@ contrib doctor --json # machine-readable JSON output
|
|
|
205
227
|
Checks include:
|
|
206
228
|
- CLI version and runtime (Bun/Node)
|
|
207
229
|
- git and GitHub CLI availability and authentication
|
|
208
|
-
-
|
|
230
|
+
- active repo config validity and storage location
|
|
209
231
|
- Git repo state (uncommitted changes, lock files, shallow clone)
|
|
210
232
|
- Fork and remote configuration
|
|
211
233
|
- Workflow and branch setup
|
|
@@ -333,7 +355,7 @@ feat!: redesign authentication API
|
|
|
333
355
|
|
|
334
356
|
## Config File
|
|
335
357
|
|
|
336
|
-
`contrib setup` writes `.contributerc.json`
|
|
358
|
+
`contrib setup` writes `.git/contribute-now/config.json` by default. If a legacy `.contributerc.json` already exists, it remains the active source until you migrate or remove it:
|
|
337
359
|
|
|
338
360
|
```json
|
|
339
361
|
{
|
|
@@ -348,7 +370,7 @@ feat!: redesign authentication API
|
|
|
348
370
|
}
|
|
349
371
|
```
|
|
350
372
|
|
|
351
|
-
|
|
373
|
+
Use `contrib config --edit` to change these values later without rerunning the full setup flow. If you are still on the legacy `.contributerc.json`, keep that file ignored until you migrate away from it.
|
|
352
374
|
|
|
353
375
|
---
|
|
354
376
|
|