create-agent-config 1.0.0

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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Ofer Shapira
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,163 @@
1
+ <h1 align="center">create-agent-config</h1>
2
+
3
+ <p align="center">
4
+ <strong>Your AI agent starts every session blind. Fix that in 10 seconds.</strong>
5
+ </p>
6
+
7
+ <p align="center">
8
+ One command. Detects your stack. Generates config files<br>
9
+ for Cursor, Claude Code, Copilot, Windsurf, Cline, and the AGENTS.md standard.
10
+ </p>
11
+
12
+ <p align="center">
13
+ <a href="#quick-start"><img src="https://img.shields.io/badge/Try_It_Now-22c55e?style=for-the-badge&logoColor=white" alt="Try It Now" /></a>
14
+ &nbsp;
15
+ <a href="#supported-formats"><img src="https://img.shields.io/badge/See_Formats-8b5cf6?style=for-the-badge&logoColor=white" alt="See Formats" /></a>
16
+ </p>
17
+
18
+ <p align="center">
19
+ <a href="https://github.com/ofershap/create-agent-config/stargazers"><img src="https://img.shields.io/github/stars/ofershap/create-agent-config?style=social" alt="GitHub stars" /></a>
20
+ &nbsp;
21
+ <a href="https://www.npmjs.com/package/create-agent-config"><img src="https://img.shields.io/npm/v/create-agent-config.svg" alt="npm version" /></a>
22
+ <a href="https://www.npmjs.com/package/create-agent-config"><img src="https://img.shields.io/npm/dm/create-agent-config.svg" alt="npm downloads" /></a>
23
+ <a href="https://github.com/ofershap/create-agent-config/actions/workflows/ci.yml"><img src="https://github.com/ofershap/create-agent-config/actions/workflows/ci.yml/badge.svg" alt="CI" /></a>
24
+ <a href="https://www.typescriptlang.org/"><img src="https://img.shields.io/badge/TypeScript-strict-blue" alt="TypeScript" /></a>
25
+ <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT" /></a>
26
+ <a href="https://makeapullrequest.com"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome" /></a>
27
+ </p>
28
+
29
+ ---
30
+
31
+ ## The Setup Problem
32
+
33
+ You open a project in Cursor. The agent doesn't know your stack, your conventions, your test commands. It guesses. It guesses wrong.
34
+
35
+ So you write a CLAUDE.md. Then you need .cursor/rules for Cursor. Then copilot-instructions.md for Copilot. Then .windsurfrules because half your team uses Windsurf.
36
+
37
+ That's 4 files saying roughly the same thing, and you wrote them all from scratch.
38
+
39
+ ## Quick Start
40
+
41
+ ```bash
42
+ npm create agent-config
43
+ ```
44
+
45
+ That's it. It scans your project, asks which formats you want, and writes the files.
46
+
47
+ Works with `npx` too:
48
+
49
+ ```bash
50
+ npx create-agent-config
51
+ ```
52
+
53
+ Or target a specific directory:
54
+
55
+ ```bash
56
+ npx create-agent-config ./my-project
57
+ ```
58
+
59
+ ## What It Does
60
+
61
+ 1. Scans your project directory (package.json, tsconfig, framework configs, lockfiles)
62
+ 2. Detects languages, frameworks, test runners, build tools, package manager
63
+ 3. Asks which config formats to generate
64
+ 4. Writes best-practice config files with your detected stack baked in
65
+
66
+ No API keys. No LLM calls. Works offline. Instant.
67
+
68
+ ## Supported Formats
69
+
70
+ | Format | File | Tools |
71
+ |---|---|---|
72
+ | AGENTS.md | `AGENTS.md` | Codex, Devin, Jules, 40+ agents |
73
+ | Claude Code | `CLAUDE.md` | Claude Code |
74
+ | Cursor | `.cursor/rules/project.mdc` | Cursor IDE (modern format) |
75
+ | GitHub Copilot | `.github/copilot-instructions.md` | GitHub Copilot |
76
+ | Windsurf | `.windsurfrules` | Windsurf / Codeium |
77
+ | Cline | `.clinerules` | Cline |
78
+
79
+ All formats get the same detected information - your stack, commands, conventions, project structure. Edit them after generation to add project-specific rules.
80
+
81
+ ## What Gets Detected
82
+
83
+ | Category | Examples |
84
+ |---|---|
85
+ | Languages | TypeScript, JavaScript, Python, Rust, Go |
86
+ | Frameworks | Next.js, React, Vue, Nuxt, Angular, Svelte, NestJS, Express, Fastify, Hono, Django, FastAPI |
87
+ | Test runners | Vitest, Jest, Mocha, Playwright, Cypress, pytest |
88
+ | Build tools | tsup, esbuild, rollup, Vite, Webpack |
89
+ | Package managers | npm, pnpm, yarn, bun |
90
+ | Monorepo tools | Turborepo, Nx, Lerna, workspaces |
91
+
92
+ Detection is static analysis only. It reads config files and package.json - nothing gets executed, nothing gets uploaded.
93
+
94
+ ## Generated Output
95
+
96
+ Here's what a generated `AGENTS.md` looks like for a Next.js + TypeScript project:
97
+
98
+ ```markdown
99
+ # my-app
100
+
101
+ ## Project
102
+
103
+ Languages: TypeScript
104
+ Frameworks: Next.js, React
105
+ Testing: Vitest
106
+ Package manager: pnpm
107
+
108
+ ## Commands
109
+
110
+ - Dev server: `pnpm dev`
111
+ - Build: `pnpm build`
112
+ - Test: `pnpm test`
113
+ - Lint: `pnpm lint`
114
+
115
+ ## Conventions
116
+
117
+ - Use TypeScript strict mode
118
+ - Prefer `const` over `let`, avoid `any`
119
+ - Use explicit return types on exported functions
120
+ - Functional components only, no class components
121
+ - Use hooks for state and side effects
122
+
123
+ ## Rules
124
+
125
+ - Do not modify generated files in `dist/` or `build/`
126
+ - Run tests before committing
127
+ - Keep commits small and focused
128
+ ```
129
+
130
+ The Cursor `.mdc` format includes YAML frontmatter with `alwaysApply: true` so rules load automatically.
131
+
132
+ ## Existing Files Are Safe
133
+
134
+ If a config file already exists, it gets skipped. You won't lose anything.
135
+
136
+ ## Tech Stack
137
+
138
+ | | |
139
+ |---|---|
140
+ | **Language** | ![TypeScript](https://img.shields.io/badge/TypeScript-strict-3178C6?logo=typescript&logoColor=white) |
141
+ | **Testing** | ![Vitest](https://img.shields.io/badge/Vitest-6E9F18?logo=vitest&logoColor=white) |
142
+ | **Bundler** | ![tsup](https://img.shields.io/badge/tsup-ESM%20%2B%20CJS-yellow) |
143
+ | **CI** | ![GitHub Actions](https://img.shields.io/badge/GitHub_Actions-2088FF?logo=githubactions&logoColor=white) |
144
+ | **Dependencies** | Zero runtime deps |
145
+
146
+ ## Contributing
147
+
148
+ Contributions welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
149
+
150
+ ## Author
151
+
152
+ [![Made by ofershap](https://gitshow.dev/api/card/ofershap)](https://gitshow.dev/ofershap)
153
+
154
+ [![LinkedIn](https://img.shields.io/badge/LinkedIn-Connect-0A66C2?style=flat&logo=linkedin&logoColor=white)](https://linkedin.com/in/ofershap)
155
+ [![GitHub](https://img.shields.io/badge/GitHub-Follow-181717?style=flat&logo=github&logoColor=white)](https://github.com/ofershap)
156
+
157
+ ---
158
+
159
+ If this helped you, [star the repo](https://github.com/ofershap/create-agent-config), [open an issue](https://github.com/ofershap/create-agent-config/issues) if something breaks, or [start a discussion](https://github.com/ofershap/create-agent-config/discussions).
160
+
161
+ ## License
162
+
163
+ [MIT](LICENSE) &copy; [Ofer Shapira](https://github.com/ofershap)