agentscfg 0.1.0-alpha.1 → 0.1.0-alpha.2
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 +28 -50
- package/dist/cli.cjs +704 -226
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -3,37 +3,23 @@
|
|
|
3
3
|
Define AI coding agent configuration once in `.agentscfg/`, then generate equivalent
|
|
4
4
|
config for Claude Code, OpenCode, and Codex CLI.
|
|
5
5
|
|
|
6
|
-
## Requirements
|
|
7
|
-
|
|
8
|
-
- Bun (v1.2+)
|
|
9
|
-
|
|
10
6
|
## Install
|
|
11
7
|
|
|
12
8
|
```bash
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
```bash
|
|
19
|
-
bun run index.ts <command> [flags]
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
## Run (npx/bunx)
|
|
23
|
-
|
|
24
|
-
```bash
|
|
25
|
-
npx agentscfg <command> [flags]
|
|
26
|
-
bunx agentscfg <command> [flags]
|
|
9
|
+
npm install -g agentscfg
|
|
10
|
+
# or
|
|
11
|
+
npx agentscfg <command>
|
|
12
|
+
bunx agentscfg <command>
|
|
27
13
|
```
|
|
28
14
|
|
|
29
|
-
##
|
|
15
|
+
## Quick Start
|
|
30
16
|
|
|
31
17
|
```bash
|
|
32
|
-
|
|
18
|
+
agentscfg init
|
|
33
19
|
# edit .agentscfg/instructions/* and .agentscfg/skills/*
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
20
|
+
agentscfg plan
|
|
21
|
+
agentscfg diff
|
|
22
|
+
agentscfg sync
|
|
37
23
|
```
|
|
38
24
|
|
|
39
25
|
## Commands
|
|
@@ -47,7 +33,9 @@ sync [--to ...] [--remove] [--adopt] [--force] [--allow-dirty]
|
|
|
47
33
|
doctor
|
|
48
34
|
```
|
|
49
35
|
|
|
50
|
-
|
|
36
|
+
Run `agentscfg <command> --help` for detailed help on each command.
|
|
37
|
+
|
|
38
|
+
## Canonical Layout
|
|
51
39
|
|
|
52
40
|
```
|
|
53
41
|
.agentscfg/
|
|
@@ -70,61 +58,51 @@ doctor
|
|
|
70
58
|
.managed.json
|
|
71
59
|
```
|
|
72
60
|
|
|
73
|
-
##
|
|
74
|
-
|
|
75
|
-
- Instructions: `.agentscfg/instructions/BASE.md` (+ optional `PROJECT.md`)
|
|
76
|
-
- Skills: `.agentscfg/skills/<skill>/SKILL.md` (+ optional resources)
|
|
77
|
-
- Targets (tool settings): `.agentscfg/targets/<tool>/**`
|
|
78
|
-
- MCP config: `.agentscfg/mcp/mcp.json`
|
|
79
|
-
|
|
80
|
-
## Outputs (repo-only)
|
|
61
|
+
## Outputs
|
|
81
62
|
|
|
82
63
|
- Claude Code: `CLAUDE.md`, `.claude/skills/<skill>/...`
|
|
83
64
|
- OpenCode: `.opencode/agent/default.md`, `.opencode/skill/<skill>/...`
|
|
84
|
-
- plus a Claude-compatible skills path in `.claude/skills/<skill>/...`
|
|
85
65
|
- Codex CLI: `AGENTS.md`, `.codex/skills/<skill>/...`
|
|
86
66
|
|
|
87
|
-
### Target
|
|
67
|
+
### Target Mappings
|
|
88
68
|
|
|
89
|
-
All files under `.agentscfg/targets/<tool>/` are synced into the tool
|
|
69
|
+
All files under `.agentscfg/targets/<tool>/` are synced into the tool's config
|
|
90
70
|
directory:
|
|
91
71
|
|
|
92
72
|
- `.agentscfg/targets/claude/**` → `.claude/**`
|
|
93
73
|
- `.agentscfg/targets/opencode/**` → `.opencode/**`
|
|
94
74
|
- `.agentscfg/targets/codex/**` → `.codex/**`
|
|
95
75
|
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
- `.agentscfg/targets/claude.settings.json` → `.claude/settings.json`
|
|
99
|
-
- `.agentscfg/targets/opencode.json` → `opencode.json`
|
|
100
|
-
- `.agentscfg/targets/codex.config.toml` → `.codex/config.toml`
|
|
101
|
-
|
|
102
|
-
MCP is synced separately:
|
|
76
|
+
MCP config:
|
|
103
77
|
|
|
104
78
|
- `.agentscfg/mcp/mcp.json` → `.mcp.json`
|
|
105
79
|
|
|
106
|
-
## Managed
|
|
80
|
+
## Managed Files
|
|
107
81
|
|
|
108
82
|
- Generated files include a `agentscfg:generated ... sha256=...` marker.
|
|
109
83
|
- Guided mode (default) will not overwrite unmanaged files unless you pass
|
|
110
84
|
`--adopt` or the file already contains the marker.
|
|
111
|
-
- If a generated file
|
|
85
|
+
- If a generated file's hash marker does not match, sync refuses to overwrite
|
|
112
86
|
unless `--force` is provided.
|
|
113
87
|
- `sync` refuses to run on a dirty git working tree unless `--allow-dirty` is set.
|
|
114
88
|
|
|
115
|
-
## Notes
|
|
116
|
-
|
|
117
|
-
- v0.1 is repo-only (no global/HOME sync).
|
|
118
|
-
- `agentscfg init` creates a starter `.agentscfg/` workspace.
|
|
119
|
-
|
|
120
89
|
## Tips
|
|
121
90
|
|
|
122
|
-
|
|
91
|
+
Add generated paths to `.gitignore` and use `agentscfg sync` to regenerate them:
|
|
123
92
|
|
|
124
93
|
```text
|
|
125
94
|
.claude/
|
|
126
95
|
.codex/
|
|
127
96
|
.opencode/
|
|
97
|
+
.mcp.json
|
|
128
98
|
AGENTS.md
|
|
129
99
|
CLAUDE.md
|
|
130
100
|
```
|
|
101
|
+
|
|
102
|
+
## Development
|
|
103
|
+
|
|
104
|
+
```bash
|
|
105
|
+
bun install
|
|
106
|
+
bun test
|
|
107
|
+
bun run build
|
|
108
|
+
```
|