agentscfg 0.1.0-alpha.1 → 0.1.0-alpha.3
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 +32 -52
- package/dist/cli.cjs +1005 -262
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -3,37 +3,24 @@
|
|
|
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 gen
|
|
23
|
+
agentscfg import --from codex
|
|
37
24
|
```
|
|
38
25
|
|
|
39
26
|
## Commands
|
|
@@ -43,11 +30,14 @@ init [--force]
|
|
|
43
30
|
validate
|
|
44
31
|
plan [--to claude,opencode,codex] [--json]
|
|
45
32
|
diff [--to ...]
|
|
46
|
-
|
|
33
|
+
gen [--to ...] [--remove] [--adopt] [--force] [--allow-dirty]
|
|
34
|
+
import --from <tool>
|
|
47
35
|
doctor
|
|
48
36
|
```
|
|
49
37
|
|
|
50
|
-
|
|
38
|
+
Run `agentscfg <command> --help` for detailed help on each command.
|
|
39
|
+
|
|
40
|
+
## Canonical Layout
|
|
51
41
|
|
|
52
42
|
```
|
|
53
43
|
.agentscfg/
|
|
@@ -70,61 +60,51 @@ doctor
|
|
|
70
60
|
.managed.json
|
|
71
61
|
```
|
|
72
62
|
|
|
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)
|
|
63
|
+
## Outputs
|
|
81
64
|
|
|
82
65
|
- Claude Code: `CLAUDE.md`, `.claude/skills/<skill>/...`
|
|
83
66
|
- OpenCode: `.opencode/agent/default.md`, `.opencode/skill/<skill>/...`
|
|
84
|
-
- plus a Claude-compatible skills path in `.claude/skills/<skill>/...`
|
|
85
67
|
- Codex CLI: `AGENTS.md`, `.codex/skills/<skill>/...`
|
|
86
68
|
|
|
87
|
-
### Target
|
|
69
|
+
### Target Mappings
|
|
88
70
|
|
|
89
|
-
All files under `.agentscfg/targets/<tool>/` are
|
|
71
|
+
All files under `.agentscfg/targets/<tool>/` are generated into the tool's config
|
|
90
72
|
directory:
|
|
91
73
|
|
|
92
74
|
- `.agentscfg/targets/claude/**` → `.claude/**`
|
|
93
75
|
- `.agentscfg/targets/opencode/**` → `.opencode/**`
|
|
94
76
|
- `.agentscfg/targets/codex/**` → `.codex/**`
|
|
95
77
|
|
|
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:
|
|
78
|
+
MCP config:
|
|
103
79
|
|
|
104
80
|
- `.agentscfg/mcp/mcp.json` → `.mcp.json`
|
|
105
81
|
|
|
106
|
-
## Managed
|
|
82
|
+
## Managed Files
|
|
107
83
|
|
|
108
84
|
- Generated files include a `agentscfg:generated ... sha256=...` marker.
|
|
109
85
|
- Guided mode (default) will not overwrite unmanaged files unless you pass
|
|
110
86
|
`--adopt` or the file already contains the marker.
|
|
111
|
-
- If a generated file
|
|
87
|
+
- If a generated file's hash marker does not match, gen refuses to overwrite
|
|
112
88
|
unless `--force` is provided.
|
|
113
|
-
- `
|
|
114
|
-
|
|
115
|
-
## Notes
|
|
116
|
-
|
|
117
|
-
- v0.1 is repo-only (no global/HOME sync).
|
|
118
|
-
- `agentscfg init` creates a starter `.agentscfg/` workspace.
|
|
89
|
+
- `gen` refuses to run on a dirty git working tree unless `--allow-dirty` is set.
|
|
119
90
|
|
|
120
91
|
## Tips
|
|
121
92
|
|
|
122
|
-
|
|
93
|
+
Add generated paths to `.gitignore` and use `agentscfg gen` to regenerate them:
|
|
123
94
|
|
|
124
95
|
```text
|
|
125
96
|
.claude/
|
|
126
97
|
.codex/
|
|
127
98
|
.opencode/
|
|
99
|
+
.mcp.json
|
|
128
100
|
AGENTS.md
|
|
129
101
|
CLAUDE.md
|
|
130
102
|
```
|
|
103
|
+
|
|
104
|
+
## Development
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
bun install
|
|
108
|
+
bun test
|
|
109
|
+
bun run build
|
|
110
|
+
```
|