@dalzoubi/dev-agents-sync 1.0.7 → 1.0.8
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 +88 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
# @dalzoubi/dev-agents-sync
|
|
2
|
+
|
|
3
|
+
CLI for syncing managed dev-agent prompts from `dalzoubi/dev-agents` into consumer repositories for Claude Code and Cursor.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
Run with `npx` from the root of the repo that should receive the agent files:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npx --yes @dalzoubi/dev-agents-sync@1 init --targets claude,cursor
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
The CLI requires Node.js 20 or newer.
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
The source repository is private, so the CLI needs a GitHub token that can read `dalzoubi/dev-agents`.
|
|
18
|
+
|
|
19
|
+
Authentication is resolved in this order:
|
|
20
|
+
|
|
21
|
+
1. `--token <token>`
|
|
22
|
+
2. `GITHUB_TOKEN`
|
|
23
|
+
3. `gh auth token`
|
|
24
|
+
|
|
25
|
+
For local use, authenticate with the GitHub CLI:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
gh auth login
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
For CI, set `GITHUB_TOKEN` or a repo secret such as `DEV_AGENTS_TOKEN`.
|
|
32
|
+
|
|
33
|
+
## Quick Start
|
|
34
|
+
|
|
35
|
+
Initialize a consumer repo:
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
npx --yes @dalzoubi/dev-agents-sync@1 init --targets claude
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
This writes managed files into `.claude/` and creates `.dev-agents-sync.json` with the resolved content version.
|
|
42
|
+
|
|
43
|
+
Update to the latest matching content version:
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
npx --yes @dalzoubi/dev-agents-sync@1 update
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Check whether managed files are in sync:
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
npx --yes @dalzoubi/dev-agents-sync@1 check
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
Show the expected diff without writing files:
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
npx --yes @dalzoubi/dev-agents-sync@1 diff
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Show lockfile status:
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
npx --yes @dalzoubi/dev-agents-sync@1 status
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Common Flags
|
|
68
|
+
|
|
69
|
+
- `--targets claude,cursor` selects output targets. Use `claude`, `cursor`, or both.
|
|
70
|
+
- `--range ^1` selects the content version range. The default is `^1`.
|
|
71
|
+
- `--dry-run` prints the planned changes without writing files.
|
|
72
|
+
- `--force` allows overwriting unmanaged file collisions.
|
|
73
|
+
- `--token <token>` passes a GitHub token directly.
|
|
74
|
+
|
|
75
|
+
## Safety
|
|
76
|
+
|
|
77
|
+
Managed files include a marker:
|
|
78
|
+
|
|
79
|
+
```html
|
|
80
|
+
<!-- managed-by: dev-agents-sync vX.Y.Z -->
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
The CLI overwrites files with this marker. It refuses to overwrite unmarked files unless `--force` is provided.
|
|
84
|
+
|
|
85
|
+
## License
|
|
86
|
+
|
|
87
|
+
UNLICENSED. This package is proprietary and all rights are reserved.
|
|
88
|
+
|
package/package.json
CHANGED