agents-md-gen 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 +34 -0
- package/package.json +10 -2
package/README.md
CHANGED
|
@@ -39,6 +39,40 @@ It won't overwrite an existing `AGENTS.md`/`CLAUDE.md` unless you pass
|
|
|
39
39
|
`--force` — this is meant to bootstrap a file you then edit by hand, not to
|
|
40
40
|
clobber one you already wrote.
|
|
41
41
|
|
|
42
|
+
## Example
|
|
43
|
+
|
|
44
|
+
Real output — this is what `npx agents-md-gen` produces when run against
|
|
45
|
+
this package's own repo:
|
|
46
|
+
|
|
47
|
+
````markdown
|
|
48
|
+
# AGENTS.md
|
|
49
|
+
|
|
50
|
+
> Generated by [agents-md-gen](https://www.npmjs.com/package/agents-md-gen) — a starting point, edit freely.
|
|
51
|
+
|
|
52
|
+
## Node.js
|
|
53
|
+
**agents-md-gen** — package manager: npm
|
|
54
|
+
|
|
55
|
+
### Commands
|
|
56
|
+
|
|
57
|
+
- Install: `npm install`
|
|
58
|
+
- Test: `npm run test`
|
|
59
|
+
|
|
60
|
+
## Structure
|
|
61
|
+
|
|
62
|
+
- `.github/` — GitHub config (CI, templates)
|
|
63
|
+
- `LICENSE`
|
|
64
|
+
- `README.md`
|
|
65
|
+
- `bin/` — CLI entry points
|
|
66
|
+
- `package.json`
|
|
67
|
+
- `src/` — source code
|
|
68
|
+
- `test/` — tests
|
|
69
|
+
|
|
70
|
+
## Notes
|
|
71
|
+
|
|
72
|
+
- CI: GitHub Actions (test.yml)
|
|
73
|
+
- License: MIT
|
|
74
|
+
````
|
|
75
|
+
|
|
42
76
|
## Why
|
|
43
77
|
|
|
44
78
|
Most `AGENTS.md`/`CLAUDE.md` files either don't exist yet, or are a stale
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "agents-md-gen",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Generate a solid AGENTS.md / CLAUDE.md for any repo by detecting its stack, commands, and structure",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"bin": {
|
|
7
|
-
"agents-md-gen": "
|
|
7
|
+
"agents-md-gen": "bin/cli.js"
|
|
8
8
|
},
|
|
9
9
|
"main": "src/index.js",
|
|
10
10
|
"files": [
|
|
@@ -18,6 +18,14 @@
|
|
|
18
18
|
"agents.md",
|
|
19
19
|
"claude.md",
|
|
20
20
|
"ai-agents",
|
|
21
|
+
"ai-coding-agent",
|
|
22
|
+
"coding-agent",
|
|
23
|
+
"claude-code",
|
|
24
|
+
"cursor",
|
|
25
|
+
"windsurf",
|
|
26
|
+
"github-copilot",
|
|
27
|
+
"openai-codex",
|
|
28
|
+
"readme-generator",
|
|
21
29
|
"cli",
|
|
22
30
|
"codegen",
|
|
23
31
|
"developer-tools"
|