thomas-agentkit 0.5.2 → 0.5.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 +18 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -14,7 +14,7 @@ Install templates into the current directory:
|
|
|
14
14
|
npx thomas-agentkit init
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
By default, `init` opens a short interactive setup flow in terminals.
|
|
17
|
+
By default, `init` opens a short interactive setup flow in terminals. It asks where to install files, what project type or preset to use, which AI tools you use, which template set to install, how to handle existing files, and whether to personalize repository-level placeholders such as project name, description, issue tracker, docs paths, stack summary, and project commands.
|
|
18
18
|
|
|
19
19
|
Install into another directory:
|
|
20
20
|
|
|
@@ -98,6 +98,8 @@ npx thomas-agentkit init --write-config
|
|
|
98
98
|
|
|
99
99
|
`--write-config` writes `agentkit.config.json` in the target directory. Existing config files are skipped by default; use `--force` to overwrite one intentionally.
|
|
100
100
|
|
|
101
|
+
Config values are validated when loaded. Unknown config keys, invalid preset/template/design-system names, invalid AI tool names, and non-string personalization values exit with an error.
|
|
102
|
+
|
|
101
103
|
List bundled templates:
|
|
102
104
|
|
|
103
105
|
```bash
|
|
@@ -145,12 +147,25 @@ Generated content
|
|
|
145
147
|
<!-- agentkit:end agents -->
|
|
146
148
|
```
|
|
147
149
|
|
|
148
|
-
`agentkit update` only replaces content inside matching managed blocks. User edits before or after those blocks are preserved. Existing legacy files without managed blocks are reported as unmanaged and left untouched.
|
|
150
|
+
`agentkit update` creates missing managed files. For existing files, it only replaces content inside matching managed blocks. User edits before or after those blocks are preserved. Existing legacy files without managed blocks are reported as unmanaged and left untouched. Files with malformed managed block markers are skipped.
|
|
149
151
|
|
|
150
|
-
Interactive personalization only applies during `agentkit init` when files are created or overwritten. It does not write a config file, and `agentkit update` does not reapply personalized values.
|
|
152
|
+
Interactive personalization only applies during `agentkit init` when files are created or overwritten. It does not write a config file unless `--write-config` is passed, and `agentkit update` does not reapply personalized values.
|
|
151
153
|
|
|
152
154
|
`agentkit.config.json` can set `preset`, `templateSet`, `designSystem`, `aiTools`, and `personalization` defaults. `templateSet` may be `minimal`, `standard`, or `full`; `designSystem` selects which bundled design-system variant fills `DESIGN-SYSTEM.md` (`linear` or `apple`); `aiTools` may include `codex`, `cursor`, `claude`, and `copilot`. `agentkit update` uses config `preset` and `designSystem` and continues to update all managed bundled templates.
|
|
153
155
|
|
|
156
|
+
Template set mappings:
|
|
157
|
+
|
|
158
|
+
- `minimal`: `AGENTS.md`
|
|
159
|
+
- `standard`: `AGENTS.md`, `CODE-QUALITY.md`, `DESIGN-SYSTEM.md`, `WORKFLOWS.md`
|
|
160
|
+
- `full`: all bundled templates
|
|
161
|
+
|
|
162
|
+
AI tool mappings:
|
|
163
|
+
|
|
164
|
+
- `codex`: `AGENTS.md`
|
|
165
|
+
- `cursor`: `.cursor/rules/agentkit.md`
|
|
166
|
+
- `claude`: `CLAUDE.md`
|
|
167
|
+
- `copilot`: `.github/copilot-instructions.md`
|
|
168
|
+
|
|
154
169
|
## Presets
|
|
155
170
|
|
|
156
171
|
Presets add stack-specific guidance without scaffolding framework app files.
|