@devel-solid/agentscli 0.1.0 → 0.1.1
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 +19 -3
- package/dist/assets/skills/agentscli-update-agents/SKILL.md +2 -0
- package/dist/assets/skills/agentscli-write-conventions/SKILL.md +2 -0
- package/dist/assets/templates/en/AGENTS.tpl.md +2 -2
- package/dist/assets/templates/en/project.tpl.md +1 -3
- package/dist/assets/templates/pt-br/AGENTS.tpl.md +2 -2
- package/dist/assets/templates/pt-br/project.tpl.md +1 -3
- package/package.json +4 -6
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# agentscli
|
|
2
2
|
|
|
3
3
|
Generate a project's `AGENTS.md` and conventions from editable Markdown templates.
|
|
4
|
-
Package **@devel-solid/agentscli**, experimental version **0.1.
|
|
4
|
+
Package **@devel-solid/agentscli**, experimental version **0.1.1**, licensed under MIT.
|
|
5
5
|
Requires Node.js 22, 24, or 26. The executable is `agentscli`.
|
|
6
6
|
|
|
7
7
|
## Use
|
|
@@ -51,13 +51,24 @@ The main template needs one H1 and one full-line insertion comment outside examp
|
|
|
51
51
|
Other headings, sections, and text are yours to customize:
|
|
52
52
|
|
|
53
53
|
~~~markdown
|
|
54
|
-
#
|
|
54
|
+
# AGENTS.md
|
|
55
55
|
|
|
56
|
-
|
|
56
|
+
## Working in this project
|
|
57
|
+
|
|
58
|
+
Read the project context convention before making changes. Follow the conventions relevant to the current task and keep changes within the requested scope.
|
|
59
|
+
|
|
60
|
+
<!-- Replace this comment with the project's purpose and essential repository orientation. -->
|
|
61
|
+
|
|
62
|
+
## Conventions
|
|
57
63
|
|
|
58
64
|
<!-- agentscli:conventions -->
|
|
59
65
|
~~~
|
|
60
66
|
|
|
67
|
+
Replace each fill-in comment itself with verified project content in its template;
|
|
68
|
+
keep the technical insertion and discovery markers. Upgrading the CLI does not replace
|
|
69
|
+
existing valid templates. To adopt new defaults, edit those templates deliberately,
|
|
70
|
+
then run `sync` when generation is requested.
|
|
71
|
+
|
|
61
72
|
Each convention template needs one H1 and one nonempty discovery card outside examples:
|
|
62
73
|
|
|
63
74
|
~~~markdown
|
|
@@ -137,6 +148,11 @@ npm pack --dry-run
|
|
|
137
148
|
npm pack --pack-destination .tmp
|
|
138
149
|
~~~
|
|
139
150
|
|
|
151
|
+
Run `npm run setup` after each clone to configure the native Git hook in
|
|
152
|
+
`.githooks/pre-push` using this checkout's local `core.hooksPath`. Repeating setup
|
|
153
|
+
is safe; a different existing hooks path is reported without replacing it.
|
|
154
|
+
The hook runs `npm run check` and blocks the push if that command fails.
|
|
155
|
+
|
|
140
156
|
`npm test` runs only lightweight unit tests with isolated data or mocked boundaries.
|
|
141
157
|
`check`, pre-push, and CI add type/format checks to that same unit gate. Build and
|
|
142
158
|
archive inspection are delivery checks. The package contains compiled runtime/client
|
|
@@ -23,6 +23,8 @@ Move detailed domain rules, lengthy procedures, examples, and instructions relev
|
|
|
23
23
|
|
|
24
24
|
Preserve established decisions outside the request. Check commands, paths, links, duplicated guidance, and contradictions against current project files. Do not invent tools or policies.
|
|
25
25
|
|
|
26
|
+
When authorized to populate project content, replace the applicable fill-in comment itself with verified content; do not leave the hint beside the completed text. The main default asks only for project purpose and essential repository orientation. Report missing facts rather than inventing them. Any new fill-in guidance must be an HTML comment explicitly asking the author to replace that comment. Fill-in hints are separate from operational markers: preserve the convention-index insertion comment in client templates.
|
|
27
|
+
|
|
26
28
|
## Preserve the format
|
|
27
29
|
|
|
28
30
|
In client mode, preserve valid UTF-8, exactly one H1, and exactly one full-line operational insertion comment outside examples:
|
|
@@ -32,6 +32,8 @@ First check whether an existing convention covers the requested subject. Keep th
|
|
|
32
32
|
- Check related rules for duplication, contradiction, ambiguity, and stale references. Prefer one normative source with useful links. Surface unresolved policy choices rather than inventing a priority.
|
|
33
33
|
- Split topics when they are consulted for different decisions, without adding inheritance or subconventions.
|
|
34
34
|
|
|
35
|
+
When authorized to populate a convention, replace its applicable fill-in comment itself with verified project content; do not leave the hint beside the completed text. For the project context template, use the actual project context. Report missing facts rather than inventing architecture, commands, or policies. Any new fill-in guidance must be an HTML comment explicitly asking the author to replace that comment. Preserve the convention's title and operational AGENT-CARD when replacing fill-in hints in client templates.
|
|
36
|
+
|
|
35
37
|
## Check the applicable format
|
|
36
38
|
|
|
37
39
|
Client templates require valid UTF-8, one H1, and exactly one complete, nonempty card outside code examples:
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
#
|
|
1
|
+
# AGENTS.md
|
|
2
2
|
|
|
3
3
|
## Working in this project
|
|
4
4
|
|
|
5
5
|
Read the project context convention before making changes. Follow the conventions relevant to the current task and keep changes within the requested scope.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
<!-- Replace this comment with the project's purpose and essential repository orientation. -->
|
|
8
8
|
|
|
9
9
|
## Conventions
|
|
10
10
|
|
|
@@ -4,6 +4,4 @@
|
|
|
4
4
|
Read when starting work or choosing the project's development workflow.
|
|
5
5
|
<!-- AGENT-CARD END -->
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
Keep unrelated changes outside the current request. Check existing conventions before adding another rule.
|
|
7
|
+
<!-- Replace this comment with the project's actual context. -->
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
#
|
|
1
|
+
# AGENTS.md
|
|
2
2
|
|
|
3
3
|
## Trabalho neste projeto
|
|
4
4
|
|
|
5
5
|
Leia a convenção de contexto do projeto antes de fazer alterações. Siga as convenções relevantes para a tarefa atual e mantenha as alterações dentro do escopo solicitado.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
<!-- Substitua este comentário pelo propósito do projeto e pela orientação essencial sobre o repositório. -->
|
|
8
8
|
|
|
9
9
|
## Convenções
|
|
10
10
|
|
|
@@ -4,6 +4,4 @@
|
|
|
4
4
|
Leia ao iniciar um trabalho ou escolher o fluxo de desenvolvimento do projeto.
|
|
5
5
|
<!-- AGENT-CARD END -->
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
Mantenha alterações não relacionadas fora do pedido atual. Confira as convenções existentes antes de acrescentar outra regra.
|
|
7
|
+
<!-- Substitua este comentário pelo contexto real do projeto. -->
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@devel-solid/agentscli",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Generate project AGENTS.md and conventions from editable Markdown templates.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -23,13 +23,12 @@
|
|
|
23
23
|
"scripts": {
|
|
24
24
|
"build": "node scripts/clean-dist.mjs && tsc && node scripts/package-assets.mjs",
|
|
25
25
|
"typecheck": "tsc --noEmit",
|
|
26
|
-
"format": "prettier --write src scripts tests/unit package.json tsconfig.json .github/workflows/node.yml
|
|
27
|
-
"format:check": "prettier --check src scripts tests/unit package.json tsconfig.json .github/workflows/node.yml
|
|
26
|
+
"format": "prettier --write src scripts tests/unit package.json tsconfig.json .github/workflows/node.yml agentscli.yml",
|
|
27
|
+
"format:check": "prettier --check src scripts tests/unit package.json tsconfig.json .github/workflows/node.yml agentscli.yml",
|
|
28
28
|
"test": "tsc && node scripts/test.mjs",
|
|
29
29
|
"check": "npm run typecheck && npm run format:check && npm test",
|
|
30
30
|
"setup": "node scripts/setup.mjs",
|
|
31
|
-
"prepack": "npm run build"
|
|
32
|
-
"lefthook:install": "lefthook install"
|
|
31
|
+
"prepack": "npm run build"
|
|
33
32
|
},
|
|
34
33
|
"engines": {
|
|
35
34
|
"node": "^22.0.0 || ^24.0.0 || ^26.0.0"
|
|
@@ -41,7 +40,6 @@
|
|
|
41
40
|
},
|
|
42
41
|
"devDependencies": {
|
|
43
42
|
"@types/node": "22.20.5",
|
|
44
|
-
"lefthook": "2.1.8",
|
|
45
43
|
"prettier": "3.9.10",
|
|
46
44
|
"typescript": "7.0.2"
|
|
47
45
|
}
|