@@ -14,16 +14,37 @@ persistence invariants, and side-effect rules. See
1414
1515## Install
1616
17- GitContribute requires Go 1.26 or newer. A C toolchain is not required because
18- the SQLite driver is pure Go.
17+ The recommended installation and onboarding command requires Node.js 18 or
18+ newer. It runs the native GitContribute binary bundled in the npm package; Go
19+ and a C toolchain are not required.
1920
2021``` sh
21- go install github.com/morluto/gitcontribute/cmd/gitcontribute@latest
22+ npx gitcontribute@latest setup
23+ ```
24+
25+ Install a persistent shell command instead:
26+
27+ ``` sh
28+ npm install --global gitcontribute@latest
29+ gitcontribute setup
2230```
2331
24- Or build a checkout:
32+ Projects that want to pin the CLI version can install it as a development
33+ dependency and invoke it through ` npx ` or package scripts:
2534
2635``` sh
36+ npm install --save-dev gitcontribute
37+ npx gitcontribute setup --codex --yes
38+ ```
39+
40+ The npm package has no install lifecycle and does not download an executable at
41+ install time. It contains native binaries for macOS ARM64/x64, Linux
42+ ARM64/x64, and Windows x64.
43+
44+ Developers with Go 1.26 or newer can install from source or build a checkout:
45+
46+ ``` sh
47+ go install github.com/morluto/gitcontribute/cmd/gitcontribute@latest
2748go build -o gitcontribute ./cmd/gitcontribute
2849```
2950
@@ -35,18 +56,40 @@ You also need a `git` executable. Optional helpers that the CLI can use:
3556## Quick start
3657
3758``` sh
38- gitcontribute init
39- gitcontribute configure --token-source=env --token-source-key=GITHUB_TOKEN
40- gitcontribute sync owner/repo
41- gitcontribute search threads " connection timeout" --repo owner/repo --json
42- gitcontribute dossier build owner/repo --json
59+ npx gitcontribute@latest setup
60+ npx gitcontribute@latest sync owner/repo
61+ npx gitcontribute@latest search threads " connection timeout" --repo owner/repo --json
62+ npx gitcontribute@latest dossier build owner/repo --json
4363```
4464
4565Run ` gitcontribute --help ` and ` gitcontribute <command> --help ` for full flag
4666reference.
4767
4868## Initialization, configuration, and authentication
4969
70+ ` gitcontribute setup ` is the normal entry point. It initializes the local
71+ corpus, selects a GitHub authentication source, and registers the MCP server
72+ with Codex and/or Claude Code. It remains local-only: adding ` --repo owner/repo `
73+ creates a discovery source but does not contact GitHub or start a sync.
74+
75+ ``` sh
76+ gitcontribute setup # interactive
77+ gitcontribute setup --codex --yes # configure Codex
78+ gitcontribute setup --all-clients --yes # configure every supported client
79+ gitcontribute setup --codex --mcp-version latest --yes
80+ gitcontribute setup --token-source env \
81+ --token-source-key GITHUB_TOKEN --yes
82+ gitcontribute setup --codex --dry-run --json # inspect without writing
83+ gitcontribute remove --all-clients --yes # remove only MCP registrations
84+ gitcontribute upgrade --check # compare with the latest npm release
85+ gitcontribute upgrade --yes # update a global npm installation
86+ ```
87+
88+ When setup runs through ` npx ` , client configuration launches a released npm
89+ version rather than recording an ephemeral npm-cache path. ` remove ` never
90+ deletes the corpus or GitContribute application configuration. See
91+ [ the onboarding design] ( docs/onboarding.md ) for the complete contract.
92+
5093` gitcontribute init ` creates the default corpus database and directories if they
5194do not exist. It does not fetch anything from GitHub.
5295
0 commit comments