chore: add Claude Project Knowledge sync tooling
- scripts/sync-claude-docs.sh with sync/check/list/help subcommands - scripts/install-claude-sync-hooks.sh for one-time hook setup - .githooks/post-commit auto-syncs on dev-doc changes - .githooks/pre-push warns (non-blocking) on stale sync - .claude-sync.conf lists 11 synced documents - SYNC_MANIFEST.md provides drift-detection anchor for Claude Chat - package.json: npm run sync:docs | sync:check - .gitignore excludes .claude-sync/ output directory Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
40
scripts/README.md
Normal file
40
scripts/README.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Scripts
|
||||
|
||||
Repo-level helper scripts.
|
||||
|
||||
## Claude Project Knowledge sync
|
||||
|
||||
Keeps the Crewli dev-docs in Claude Project Knowledge aligned with the repo.
|
||||
|
||||
### One-time setup
|
||||
|
||||
```bash
|
||||
bash scripts/install-claude-sync-hooks.sh
|
||||
```
|
||||
|
||||
This points git at `.githooks/` and marks the hooks executable.
|
||||
|
||||
### Manual trigger
|
||||
|
||||
```bash
|
||||
npm run sync:docs # regenerate .claude-sync/
|
||||
npm run sync:check # verify .claude-sync/ matches dev-docs
|
||||
```
|
||||
|
||||
The underlying script also supports `list` and `help`:
|
||||
|
||||
```bash
|
||||
bash scripts/sync-claude-docs.sh list
|
||||
bash scripts/sync-claude-docs.sh help
|
||||
```
|
||||
|
||||
### Automatic
|
||||
|
||||
- `post-commit`: syncs automatically when any file in `.claude-sync.conf` is committed
|
||||
- `pre-push`: warns if `.claude-sync/` is stale before pushing (non-blocking)
|
||||
|
||||
### After sync
|
||||
|
||||
Upload everything in `.claude-sync/` (including `SYNC_MANIFEST.md`) to the
|
||||
Crewli Claude Project Knowledge, replacing existing versions. The manifest is
|
||||
what Claude Chat uses for drift detection against the current HEAD.
|
||||
Reference in New Issue
Block a user