agents-templated 1.2.0 → 1.2.2
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 +246 -383
- package/bin/cli.js +47 -36
- package/index.js +7 -7
- package/package.json +1 -1
- package/templates/.cursorrules +2 -2
- package/templates/.github/copilot-instructions.md +7 -5
- package/templates/CLAUDE.md +40 -245
- package/templates/{.gemini-instructions.md → GEMINI.md} +10 -7
- package/templates/README.md +359 -30
- package/templates/{AI_INSTRUCTIONS.md → agent-docs/AI_INSTRUCTIONS.md} +4 -4
- package/templates/agent-docs/ARCHITECTURE.md +261 -0
- package/templates/agent-docs/README.md +53 -0
- package/templates/.vscode-ai-rules.md +0 -111
- /package/templates/{AGENTS.MD → agent-docs/AGENTS.MD} +0 -0
package/README.md
CHANGED
|
@@ -1,511 +1,353 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Agents Templated
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/agents-templated)
|
|
4
4
|
[](https://www.npmjs.com/package/agents-templated)
|
|
5
5
|
[](https://opensource.org/licenses/MIT)
|
|
6
6
|
[](https://github.com/rickandrew2/agents-templated)
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
> **Agents Templated** is a CLI tool and npm package that instantly scaffolds production-ready project structures with enterprise-grade development patterns, security guidelines, and AI assistant configurations. Designed for developers who want to start projects the right way—with proven OWASP security practices, comprehensive testing strategies (80/15/5 coverage targets), and agent-based architecture patterns—without being locked into specific frameworks. It generates unified configuration files that work seamlessly with Cursor, GitHub Copilot, Claude, and Google Gemini, allowing AI assistants to automatically follow best practices from day one. Whether you're building a Next.js app, Django API, Go microservice, or any custom stack, Agents Templated provides the guardrails and patterns you need while giving you complete freedom to choose your technology.
|
|
9
9
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
This template provides proven development patterns and guidelines that work with **any** technology stack. It scaffolds project structure, AI assistant configurations, and security patterns—but does **not** install tech packages for you. After running `agents-templated init`, you independently install your chosen frameworks (React, Django, Go, etc.) into the scaffolded structure.
|
|
10
|
+
---
|
|
13
11
|
|
|
14
|
-
##
|
|
12
|
+
## What is Agents Templated?
|
|
15
13
|
|
|
16
|
-
|
|
17
|
-
- **Interactive Wizard** (v1.1.0): Guided setup with personalized recommendations
|
|
18
|
-
- **Project Validation** (v1.1.0): Automated checks for configuration and best practices
|
|
19
|
-
- **Template Updates** (v1.1.0): Keep your templates in sync with latest improvements
|
|
20
|
-
- **Technology-Agnostic**: Patterns and structure that work with any tech stack
|
|
21
|
-
- **AI Assistant Ready**: Pre-configured for Cursor, GitHub Copilot, and other AI coding tools
|
|
22
|
-
- **Security-First**: Built-in OWASP Top 10 protection patterns and security guidelines
|
|
23
|
-
- **Testing Strategy**: Defined approach with unit, integration, and E2E coverage targets
|
|
24
|
-
- **Agent-Based Architecture**: Specialized agents for frontend, backend, database, testing, security
|
|
25
|
-
- **Type-Safe Development**: Validation patterns applicable to any language
|
|
26
|
-
- **Accessibility Guidelines**: WCAG 2.1 AA compliance patterns built-in
|
|
14
|
+
Agents Templated scaffolds your project with:
|
|
27
15
|
|
|
28
|
-
|
|
16
|
+
✅ **AI Agent Configurations** – Auto-discovery files for 4 major AI coding assistants
|
|
17
|
+
✅ **Security-First Patterns** – OWASP Top 10 protection guidelines built-in
|
|
18
|
+
✅ **Testing Strategy** – 80/15/5 coverage targets (unit/integration/e2e)
|
|
19
|
+
✅ **Agent-Based Architecture** – Specialized patterns for frontend, backend, database, testing, security
|
|
20
|
+
✅ **Technology-Agnostic** – Works with React, Django, Go, FastAPI, Next.js, or any stack you choose
|
|
29
21
|
|
|
30
|
-
|
|
31
|
-
Get started instantly with pre-configured setups for popular tech stacks:
|
|
32
|
-
```bash
|
|
33
|
-
agents-templated init --preset=nextjs # Next.js full-stack app
|
|
34
|
-
agents-templated init --preset=express-api # Express.js REST API
|
|
35
|
-
agents-templated init --preset=django-react # Django + React
|
|
36
|
-
agents-templated init --preset=fastapi # FastAPI backend
|
|
37
|
-
agents-templated init --preset=go-api # Go API server
|
|
38
|
-
```
|
|
22
|
+
**Important:** This package does **NOT** install frameworks or libraries. It scaffolds the structure, patterns, and AI configurations—you install your chosen tech stack separately.
|
|
39
23
|
|
|
40
|
-
|
|
41
|
-
- Recommended package lists for your tech stack
|
|
42
|
-
- Stack-specific configuration templates
|
|
43
|
-
- Optimized .gitignore patterns
|
|
44
|
-
- Pre-configured agent rules
|
|
24
|
+
---
|
|
45
25
|
|
|
46
|
-
|
|
26
|
+
## 🚀 Quick Start
|
|
47
27
|
|
|
48
|
-
|
|
28
|
+
### 1. Run the Interactive Wizard (Recommended)
|
|
49
29
|
|
|
50
30
|
```bash
|
|
31
|
+
# Using npx (no installation needed) - RECOMMENDED
|
|
32
|
+
npx agents-templated@latest wizard
|
|
33
|
+
|
|
34
|
+
# Or install globally first
|
|
35
|
+
npm install -g agents-templated
|
|
51
36
|
agents-templated wizard
|
|
52
37
|
```
|
|
53
38
|
|
|
54
|
-
**
|
|
55
|
-
- Choose project type: fullstack, frontend, backend, CLI, package, or custom
|
|
56
|
-
- Select frameworks and databases interactively
|
|
57
|
-
- Receive personalized package recommendations
|
|
58
|
-
- Install only the components you need
|
|
59
|
-
- Get next-step guidance tailored to your stack
|
|
60
|
-
|
|
61
|
-
### ✅ Validation & Health Checks
|
|
62
|
-
|
|
63
|
-
Ensure your project follows best practices:
|
|
39
|
+
**Or use a preset for fast setup:**
|
|
64
40
|
|
|
65
41
|
```bash
|
|
66
|
-
|
|
67
|
-
agents-templated
|
|
42
|
+
# Initialize with a specific preset
|
|
43
|
+
npx agents-templated@latest init --preset=nextjs # Next.js
|
|
44
|
+
npx agents-templated@latest init --preset=express-api # Express
|
|
45
|
+
npx agents-templated@latest init --preset=django-react # Django
|
|
46
|
+
npx agents-templated@latest init --preset=fastapi # FastAPI
|
|
47
|
+
npx agents-templated@latest init --preset=go-api # Go
|
|
48
|
+
|
|
49
|
+
# Or install all components without a preset
|
|
50
|
+
npx agents-templated@latest init --all
|
|
68
51
|
```
|
|
69
52
|
|
|
70
|
-
|
|
71
|
-
- Required documentation files present
|
|
72
|
-
- Agent rules properly configured
|
|
73
|
-
- AI assistant configurations valid
|
|
74
|
-
- Security patterns implemented
|
|
75
|
-
- Testing structure in place
|
|
53
|
+
### 2. Install Your Tech Stack
|
|
76
54
|
|
|
77
|
-
|
|
55
|
+
After initializing, install your chosen framework:
|
|
78
56
|
|
|
79
|
-
|
|
57
|
+
### 2. Install Your Tech Stack
|
|
58
|
+
|
|
59
|
+
After initializing, install your chosen framework:
|
|
80
60
|
|
|
81
61
|
```bash
|
|
82
|
-
|
|
83
|
-
|
|
62
|
+
# Frontend
|
|
63
|
+
npm install next react react-dom # Next.js
|
|
64
|
+
npm install vue nuxt # Nuxt
|
|
65
|
+
npm install @angular/core @angular/cli # Angular
|
|
66
|
+
|
|
67
|
+
# Backend
|
|
68
|
+
npm install express typescript zod # Express
|
|
69
|
+
pip install django djangorestframework # Django
|
|
70
|
+
pip install fastapi uvicorn pydantic # FastAPI
|
|
71
|
+
go mod init your-project # Go
|
|
72
|
+
|
|
73
|
+
# Database
|
|
74
|
+
npm install prisma @prisma/client # Prisma ORM
|
|
75
|
+
pip install sqlalchemy alembic # SQLAlchemy
|
|
76
|
+
npm install mongoose # Mongoose (MongoDB)
|
|
84
77
|
```
|
|
85
78
|
|
|
86
|
-
|
|
87
|
-
- Automatic backup creation before updates
|
|
88
|
-
- Preview changes before applying
|
|
89
|
-
- Selective file updates
|
|
90
|
-
- Preserves your customizations
|
|
91
|
-
|
|
92
|
-
### 🧪 Comprehensive Testing
|
|
79
|
+
### 3. Start Coding with AI
|
|
93
80
|
|
|
94
|
-
|
|
95
|
-
- 10+ unit tests covering install operations
|
|
96
|
-
- Jest test framework with coverage reporting
|
|
97
|
-
- Tested on Windows, macOS, and Linux
|
|
98
|
-
- CI/CD ready with `npm run test:ci`
|
|
81
|
+
Your AI assistant will auto-load the configurations and follow enterprise patterns automatically!
|
|
99
82
|
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
**Agents Templated v1.2.0 now supports 4 major AI agents with auto-discovered configuration files:**
|
|
83
|
+
---
|
|
103
84
|
|
|
104
|
-
|
|
85
|
+
## ✨ Key Features
|
|
105
86
|
|
|
106
|
-
|
|
|
107
|
-
|
|
108
|
-
| **
|
|
109
|
-
| **
|
|
110
|
-
| **
|
|
111
|
-
|
|
|
87
|
+
| Feature | Description |
|
|
88
|
+
|---------|-------------|
|
|
89
|
+
| 🚀 **Quick Start Presets** | 5 popular tech stack presets (Next.js, Express, Django, FastAPI, Go) |
|
|
90
|
+
| 🧙 **Interactive Wizard** | Guided setup with personalized recommendations |
|
|
91
|
+
| 🤖 **4 AI Agents Supported** | Cursor, GitHub Copilot, Claude, Google Gemini (auto-discovery) |
|
|
92
|
+
| 🔒 **Security-First** | OWASP Top 10 protection patterns built-in |
|
|
93
|
+
| 🧪 **Testing Strategy** | 80/15/5 coverage targets (unit/integration/e2e) |
|
|
94
|
+
| ✅ **Project Validation** | `validate` and `doctor` commands for health checks |
|
|
95
|
+
| 🔄 **Template Updates** | Keep your templates in sync with `update` command |
|
|
96
|
+
| 🎯 **Technology-Agnostic** | Works with React, Django, Go, FastAPI, Next.js, or any stack |
|
|
97
|
+
| ♿ **Accessibility** | WCAG 2.1 AA compliance patterns included |
|
|
112
98
|
|
|
113
|
-
|
|
99
|
+
---
|
|
114
100
|
|
|
115
|
-
|
|
116
|
-
2. **Each AI agent auto-discovers its config file** in the project root
|
|
117
|
-
3. **All agents read from the same ruleset**: `agents/rules/` and `agents/skills/`
|
|
118
|
-
4. **No duplication**: Rules and guidelines live in one place
|
|
101
|
+
## 🤖 AI Agent Support
|
|
119
102
|
|
|
120
|
-
|
|
103
|
+
Agents Templated automatically configures 4 major AI coding assistants:
|
|
121
104
|
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
105
|
+
| AI Agent | Config File | Auto-Discovery |
|
|
106
|
+
|----------|-------------|----------------|
|
|
107
|
+
| **Cursor** | `.cursorrules` | ✅ Auto-loads in Cursor IDE |
|
|
108
|
+
| **GitHub Copilot** | `.github/copilot-instructions.md` | ✅ Auto-loads in VS Code |
|
|
109
|
+
| **Claude** | `CLAUDE.md` | ✅ Auto-loads in Claude IDE/API |
|
|
110
|
+
| **Gemini** | `GEMINI.md` | ✅ Auto-loads in Gemini IDE/API |
|
|
125
111
|
|
|
126
|
-
|
|
127
|
-
npx agents-templated init --all
|
|
112
|
+
**All agents follow the same rules:** `agents/rules/` directory contains unified patterns for security, testing, code style, and architecture. No duplication, one source of truth.
|
|
128
113
|
|
|
129
|
-
|
|
130
|
-
# - Open in Cursor → .cursorrules loads automatically
|
|
131
|
-
# - Open in VSCode with Copilot Chat → .vscode-ai-rules.md loads automatically
|
|
132
|
-
# - Use Gemini API → .gemini-instructions.md loads automatically
|
|
133
|
-
# - Use GitHub Copilot → .github/copilot-instructions.md loads automatically
|
|
134
|
-
```
|
|
114
|
+
---
|
|
135
115
|
|
|
136
|
-
|
|
116
|
+
## 📦 What Gets Installed
|
|
137
117
|
|
|
138
|
-
|
|
118
|
+
When you run `agents-templated init`, you get:
|
|
139
119
|
|
|
140
120
|
```
|
|
141
|
-
|
|
142
|
-
├──
|
|
143
|
-
│ ├──
|
|
144
|
-
│ ├──
|
|
145
|
-
│ ├──
|
|
146
|
-
│
|
|
147
|
-
│
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
-
|
|
158
|
-
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
**Global Installation (Recommended)**
|
|
169
|
-
|
|
170
|
-
```bash
|
|
171
|
-
npm install -g agents-templated
|
|
172
|
-
cd your-project
|
|
173
|
-
agents-templated init --preset=nextjs # or use wizard
|
|
121
|
+
your-project/
|
|
122
|
+
├── agent-docs/ # 📚 Comprehensive documentation
|
|
123
|
+
│ ├── AI_INSTRUCTIONS.md # Primary AI assistant guide
|
|
124
|
+
│ ├── ARCHITECTURE.md # Project architecture & tech stack
|
|
125
|
+
│ ├── AGENTS.MD # Agent delegation patterns
|
|
126
|
+
│ └── README.md # Human-readable setup guide
|
|
127
|
+
│
|
|
128
|
+
├── agents/ # 🤖 AI Agent rules and skills
|
|
129
|
+
│ ├── rules/
|
|
130
|
+
│ │ ├── core.mdc # Core development principles
|
|
131
|
+
│ │ ├── security.mdc # Security patterns (CRITICAL)
|
|
132
|
+
│ │ ├── testing.mdc # Testing strategy
|
|
133
|
+
│ │ ├── frontend.mdc # Frontend patterns
|
|
134
|
+
│ │ ├── database.mdc # Database patterns
|
|
135
|
+
│ │ └── style.mdc # Code style guidelines
|
|
136
|
+
│ └── skills/
|
|
137
|
+
│ ├── web-design-guidelines/ # UI/UX patterns
|
|
138
|
+
│ └── find-skills/ # Skill discovery
|
|
139
|
+
│
|
|
140
|
+
├── .github/
|
|
141
|
+
│ └── copilot-instructions.md # GitHub Copilot config
|
|
142
|
+
│
|
|
143
|
+
├── CLAUDE.md # Claude AI config
|
|
144
|
+
├── GEMINI.md # Gemini AI config
|
|
145
|
+
├── .cursorrules # Cursor IDE config
|
|
146
|
+
├── .gitignore # Pre-configured Git ignore
|
|
147
|
+
└── README.md # Project documentation
|
|
174
148
|
```
|
|
175
149
|
|
|
176
|
-
|
|
150
|
+
---
|
|
177
151
|
|
|
178
|
-
|
|
179
|
-
npm install --save-dev agents-templated
|
|
180
|
-
npx agents-templated init --preset=nextjs
|
|
181
|
-
```
|
|
152
|
+
## 📋 Command Reference
|
|
182
153
|
|
|
183
|
-
|
|
154
|
+
### Setup Commands
|
|
184
155
|
|
|
185
156
|
```bash
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
```
|
|
189
|
-
|
|
190
|
-
### 📋 CLI Commands
|
|
157
|
+
# 🧙 Interactive wizard (recommended for beginners)
|
|
158
|
+
agents-templated wizard
|
|
191
159
|
|
|
192
|
-
|
|
193
|
-
```bash
|
|
194
|
-
# Quick start with presets
|
|
160
|
+
# 🚀 Quick start with presets
|
|
195
161
|
agents-templated init --preset=nextjs # Next.js full-stack
|
|
196
|
-
agents-templated init --preset=django-react # Django + React
|
|
197
162
|
agents-templated init --preset=express-api # Express.js API
|
|
163
|
+
agents-templated init --preset=django-react # Django + React
|
|
198
164
|
agents-templated init --preset=fastapi # FastAPI
|
|
199
165
|
agents-templated init --preset=go-api # Go API
|
|
200
166
|
|
|
201
|
-
#
|
|
202
|
-
agents-templated wizard # Guided setup
|
|
203
|
-
|
|
204
|
-
# Manual component selection
|
|
167
|
+
# 🔧 Manual component selection
|
|
205
168
|
agents-templated init --all # All components
|
|
206
169
|
agents-templated init --docs # Documentation only
|
|
207
170
|
agents-templated init --rules # Agent rules only
|
|
208
171
|
agents-templated init --skills # Skills only
|
|
209
|
-
agents-templated init --github # GitHub Copilot config
|
|
210
172
|
|
|
211
|
-
# Force overwrite
|
|
212
|
-
agents-templated init --all --force
|
|
173
|
+
# ⚠️ Force overwrite existing files
|
|
174
|
+
agents-templated init --all --force
|
|
213
175
|
```
|
|
214
176
|
|
|
215
|
-
|
|
177
|
+
### Maintenance Commands
|
|
178
|
+
|
|
216
179
|
```bash
|
|
217
|
-
#
|
|
218
|
-
agents-templated validate # Quick
|
|
180
|
+
# ✅ Validate your project setup
|
|
181
|
+
agents-templated validate # Quick validation
|
|
219
182
|
agents-templated doctor # Comprehensive health check
|
|
220
183
|
|
|
221
|
-
#
|
|
222
|
-
agents-templated update # Apply
|
|
184
|
+
# 🔄 Update templates to latest version
|
|
185
|
+
agents-templated update # Apply updates with backup
|
|
223
186
|
agents-templated update --check-only # Check without installing
|
|
224
187
|
|
|
225
|
-
#
|
|
226
|
-
agents-templated list
|
|
188
|
+
# 📚 List available components and presets
|
|
189
|
+
agents-templated list
|
|
227
190
|
```
|
|
228
191
|
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
After initializing the template, install your chosen framework and dependencies. The template provides patterns but does **not** install packages for you.
|
|
192
|
+
---
|
|
232
193
|
|
|
233
|
-
|
|
234
|
-
- React/Next.js, Vue/Nuxt, Angular, Svelte/SvelteKit, or traditional SSR
|
|
194
|
+
## 🎯 After Installation: Next Steps
|
|
235
195
|
|
|
236
|
-
|
|
237
|
-
- Node.js (Express/Fastify/Nest.js), Python (Django/FastAPI/Flask), Go, Rust, Java/Spring Boot, Ruby on Rails, PHP (Laravel)
|
|
196
|
+
### 1. Install Your Tech Stack
|
|
238
197
|
|
|
239
|
-
|
|
240
|
-
- PostgreSQL, MySQL, MongoDB, SQLite, or cloud solutions (Supabase, Firebase, PlanetScale)
|
|
198
|
+
After initializing, install your chosen framework:
|
|
241
199
|
|
|
242
|
-
**Example installations:**
|
|
243
200
|
```bash
|
|
244
|
-
#
|
|
245
|
-
npm install next react react-dom
|
|
246
|
-
|
|
247
|
-
#
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
# Express
|
|
251
|
-
|
|
201
|
+
# Frontend
|
|
202
|
+
npm install next react react-dom # Next.js
|
|
203
|
+
npm install vue nuxt # Nuxt
|
|
204
|
+
npm install @angular/core @angular/cli # Angular
|
|
205
|
+
|
|
206
|
+
# Backend
|
|
207
|
+
npm install express typescript zod # Express
|
|
208
|
+
pip install django djangorestframework # Django
|
|
209
|
+
pip install fastapi uvicorn pydantic # FastAPI
|
|
210
|
+
go mod init your-project # Go
|
|
211
|
+
|
|
212
|
+
# Database
|
|
213
|
+
npm install prisma @prisma/client # Prisma ORM
|
|
214
|
+
pip install sqlalchemy alembic # SQLAlchemy
|
|
215
|
+
npm install mongoose # Mongoose (MongoDB)
|
|
252
216
|
```
|
|
253
217
|
|
|
254
|
-
###
|
|
218
|
+
### 2. Review AI Configuration Files
|
|
255
219
|
|
|
256
|
-
|
|
220
|
+
Open your AI assistant and it will automatically load the appropriate config:
|
|
257
221
|
|
|
258
|
-
**Cursor
|
|
259
|
-
-
|
|
260
|
-
-
|
|
222
|
+
- **Cursor**: Opens `.cursorrules` automatically
|
|
223
|
+
- **GitHub Copilot**: Reads `.github/copilot-instructions.md`
|
|
224
|
+
- **Claude**: Reads `CLAUDE.md`
|
|
225
|
+
- **Gemini**: Reads `GEMINI.md`
|
|
261
226
|
|
|
262
|
-
|
|
263
|
-
- Auto-loads `.github/copilot-instructions.md`
|
|
264
|
-
- Works in VS Code,VS Code Insiders, and github.com
|
|
227
|
+
### 3. Read the Documentation
|
|
265
228
|
|
|
266
|
-
**
|
|
267
|
-
-
|
|
268
|
-
-
|
|
229
|
+
- **[agent-docs/AI_INSTRUCTIONS.md](agent-docs/AI_INSTRUCTIONS.md)** – Primary AI assistant guide
|
|
230
|
+
- **[agent-docs/ARCHITECTURE.md](agent-docs/ARCHITECTURE.md)** – Project architecture & tech stack guidance
|
|
231
|
+
- **[agent-docs/AGENTS.MD](agent-docs/AGENTS.MD)** – Agent delegation patterns
|
|
232
|
+
- **[agents/rules/security.mdc](agents/rules/security.mdc)** – Security patterns (CRITICAL)
|
|
233
|
+
- **[agents/rules/testing.mdc](agents/rules/testing.mdc)** – Testing strategy
|
|
269
234
|
|
|
270
|
-
|
|
235
|
+
### 4. Start Building
|
|
271
236
|
|
|
272
|
-
|
|
237
|
+
Tell your AI assistant what to build:
|
|
273
238
|
|
|
274
239
|
```
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
│ │ ├── security.mdc # Security patterns and requirements
|
|
279
|
-
│ │ ├── testing.mdc # Testing strategy and patterns
|
|
280
|
-
│ │ ├── frontend.mdc # Frontend development patterns
|
|
281
|
-
│ │ ├── database.mdc # Database design and patterns
|
|
282
|
-
│ │ └── style.mdc # Code style and formatting rules
|
|
283
|
-
│ └── skills/ # Reusable agent skills
|
|
284
|
-
│ ├── web-design-guidelines/ # Web interface guidelines skill
|
|
285
|
-
│ └── find-skills/ # Skill discovery utilities
|
|
286
|
-
├── .github/
|
|
287
|
-
│ └── copilot-instructions.md # GitHub Copilot configuration
|
|
288
|
-
├── AGENTS.md # Agent responsibilities and usage guide
|
|
289
|
-
├── CLAUDE.md # Project guidelines and architecture
|
|
290
|
-
├── AI_INSTRUCTIONS.md # Universal AI assistant instructions
|
|
291
|
-
├── .gitignore # Pre-configured Git ignore patterns
|
|
292
|
-
└── README.md # Project documentation
|
|
240
|
+
"Create a user registration endpoint with email validation and rate limiting"
|
|
241
|
+
"Build a responsive dashboard component with dark mode support"
|
|
242
|
+
"Design a PostgreSQL schema for a blog with users, posts, and comments"
|
|
293
243
|
```
|
|
294
244
|
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
Use agents-templated programmatically in build scripts or automation:
|
|
298
|
-
|
|
299
|
-
```javascript
|
|
300
|
-
const agentsTemplated = require('agents-templated');
|
|
245
|
+
Your AI will follow the enterprise patterns automatically!
|
|
301
246
|
|
|
302
|
-
|
|
303
|
-
await agentsTemplated.install('./my-project', {
|
|
304
|
-
force: true
|
|
305
|
-
});
|
|
306
|
-
|
|
307
|
-
// Install specific components
|
|
308
|
-
await agentsTemplated.install('./my-project', {
|
|
309
|
-
docs: true,
|
|
310
|
-
rules: true,
|
|
311
|
-
skills: false,
|
|
312
|
-
github: true,
|
|
313
|
-
force: false
|
|
314
|
-
});
|
|
315
|
-
```
|
|
316
|
-
|
|
317
|
-
## \ud83d\udcda Core Configuration Files
|
|
318
|
-
\ud83e\udd16 Agent-Based Development
|
|
319
|
-
|
|
320
|
-
This template uses specialized agents for different aspects of development:
|
|
321
|
-
|
|
322
|
-
**FrontendAgent:**\nHandles UI/UX development, component creation, design system implementation, and accessibility compliance.
|
|
323
|
-
|
|
324
|
-
**BackendAgent:**\nManages API development, business logic, authentication, authorization, rate limiting, and security middleware.
|
|
247
|
+
---
|
|
325
248
|
|
|
326
|
-
|
|
249
|
+
## 🏗️ Core Principles
|
|
327
250
|
|
|
328
|
-
|
|
251
|
+
### Security-First Development
|
|
329
252
|
|
|
330
|
-
|
|
253
|
+
✅ Validate all inputs at application boundaries with schema validation
|
|
254
|
+
✅ Authenticate and authorize every protected endpoint
|
|
255
|
+
✅ Rate limit public endpoints to prevent abuse
|
|
256
|
+
✅ Sanitize outputs to prevent injection attacks
|
|
257
|
+
✅ Never expose sensitive data in error messages or logs
|
|
331
258
|
|
|
332
|
-
**
|
|
259
|
+
**Reference**: [agents/rules/security.mdc](agents/rules/security.mdc)
|
|
333
260
|
|
|
334
|
-
|
|
261
|
+
### Testing Strategy
|
|
335
262
|
|
|
336
|
-
|
|
263
|
+
- **80% Unit Tests** – Business logic, pure functions, utilities
|
|
264
|
+
- **15% Integration Tests** – API endpoints, database operations
|
|
265
|
+
- **5% E2E Tests** – Critical user journeys
|
|
337
266
|
|
|
338
|
-
|
|
339
|
-
Handles UI/UX development, component creation, design system implementation, and accessibility compliance.
|
|
267
|
+
**Reference**: [agents/rules/testing.mdc](agents/rules/testing.mdc)
|
|
340
268
|
|
|
341
|
-
###
|
|
342
|
-
Manages API development, business logic, authentication, authorization, rate limiting, and security middleware.
|
|
269
|
+
### Agent-Based Architecture
|
|
343
270
|
|
|
344
|
-
|
|
345
|
-
|
|
271
|
+
| Agent | Responsibility |
|
|
272
|
+
|-------|---------------|
|
|
273
|
+
| **FrontendAgent** | UI/UX, components, design system, accessibility |
|
|
274
|
+
| **BackendAgent** | API, business logic, authentication, middleware |
|
|
275
|
+
| **DatabaseAgent** | Schema design, migrations, query optimization |
|
|
276
|
+
| **TestAgent** | Unit, integration, E2E, accessibility testing |
|
|
277
|
+
| **SecurityAgent** | Input validation, authentication, OWASP compliance |
|
|
346
278
|
|
|
347
|
-
|
|
348
|
-
Implements comprehensive testing strategy across unit, integration, E2E, accessibility, and security testing.
|
|
279
|
+
**Reference**: [agent-docs/AGENTS.MD](agent-docs/AGENTS.MD)
|
|
349
280
|
|
|
350
|
-
|
|
351
|
-
Ensures security-first development with input validation, authentication patterns, authorization checks, and OWASP compliance.
|
|
281
|
+
---
|
|
352
282
|
|
|
353
|
-
|
|
354
|
-
Performs code reviews focusing on correctness, security, performance, test coverage, and accessibility.
|
|
283
|
+
## 📚 Available Presets
|
|
355
284
|
|
|
356
|
-
|
|
285
|
+
| Preset | Tech Stack | Best For |
|
|
286
|
+
|--------|-----------|----------|
|
|
287
|
+
| `nextjs` | Next.js + React + TypeScript | Full-stack web applications |
|
|
288
|
+
| `express-api` | Express + TypeScript + Zod | REST APIs and microservices |
|
|
289
|
+
| `django-react` | Django + React + PostgreSQL | Full-stack with Python backend |
|
|
290
|
+
| `fastapi` | FastAPI + Pydantic + SQLAlchemy | High-performance Python APIs |
|
|
291
|
+
| `go-api` | Go + Gin/Echo + PostgreSQL | Scalable Go microservices |
|
|
357
292
|
|
|
358
|
-
|
|
359
|
-
-
|
|
360
|
-
-
|
|
361
|
-
-
|
|
362
|
-
-
|
|
363
|
-
- Never expose sensitive data in error messages or logs
|
|
364
|
-
|
|
365
|
-
### Testing Strategy
|
|
366
|
-
- **Unit Tests**: 80% coverage for business logic
|
|
367
|
-
- **Integration Tests**: 15% coverage for API endpoints and database operations
|
|
368
|
-
- **E2E Tests**: 5% coverage for critical user journeys
|
|
369
|
-
- **Accessibility Tests**: WCAG 2.1 AA compliance for all UI
|
|
370
|
-
|
|
371
|
-
### Type Safety
|
|
372
|
-
- Use strong typing systems available in your chosen language
|
|
373
|
-
- Implement runtime validation for all external/user-provided data
|
|
374
|
-
- Validate at boundaries: API endpoints, form submissions, configuration
|
|
375
|
-
- Generate types from schemas when possible (OpenAPI, GraphQL, database schemas)
|
|
376
|
-
|
|
377
|
-
### Code Quality
|
|
378
|
-
- Maintain consistent patterns throughout the codebase
|
|
379
|
-
- Follow established code style guidelines
|
|
380
|
-
- Ensure proper error handling and logging
|
|
381
|
-
- Keep documentation updated with code changes
|
|
382
|
-
|
|
383
|
-
## Security Patterns
|
|
384
|
-
|
|
385
|
-
### Input Validation Example
|
|
386
|
-
|
|
387
|
-
```typescript
|
|
388
|
-
// TypeScript with Zod
|
|
389
|
-
imp\ud83d\udd12 ort { z } from 'zod'
|
|
390
|
-
|
|
391
|
-
const userSchema = z.object({
|
|
392
|
-
email: z.string().email().toLowerCase(),
|
|
393
|
-
password: z.string().min(8)
|
|
394
|
-
})
|
|
395
|
-
```
|
|
293
|
+
Each preset includes:
|
|
294
|
+
- Recommended package list
|
|
295
|
+
- Stack-specific configurations
|
|
296
|
+
- Optimized `.gitignore` patterns
|
|
297
|
+
- Pre-configured agent rules
|
|
396
298
|
|
|
397
|
-
|
|
398
|
-
# Python with Pydantic
|
|
399
|
-
from pydantic import BaseModel, EmailStr
|
|
299
|
+
---
|
|
400
300
|
|
|
401
|
-
|
|
402
|
-
email: EmailStr
|
|
403
|
-
password: str
|
|
404
|
-
```
|
|
301
|
+
## 🔧 Programmatic API
|
|
405
302
|
|
|
406
|
-
|
|
303
|
+
Use agents-templated in your build scripts or automation:
|
|
407
304
|
|
|
408
305
|
```javascript
|
|
409
|
-
|
|
410
|
-
const rateLimit = require('express-rate-limit')
|
|
411
|
-
|
|
412
|
-
const authLimiter = rateLimit({
|
|
413
|
-
windowMs: 15 * 60 * 1000, // 15 minutes
|
|
414
|
-
max: 5, // 5 attempts per window
|
|
415
|
-
message: 'Too many authentication attempts'
|
|
416
|
-
})
|
|
417
|
-
```
|
|
418
|
-
|
|
419
|
-
## Testing Strategy
|
|
420
|
-
|
|
421
|
-
### Coverage Targets
|
|
422
|
-
- **Unit Tests**: 80% coverage for business logic
|
|
423
|
-
- **Integration Tests**: 15% coverage for API endpoints and database operations
|
|
424
|
-
- **E2E Tests**: 5% coverage for critical user journeys
|
|
425
|
-
\ud83e\uddea
|
|
426
|
-
### Testing Tools by Technology
|
|
427
|
-
|
|
428
|
-
**JavaScript/TypeScript:**
|
|
429
|
-
- Unit/Integration: Jest, Vitest, or framework-specific test runners
|
|
430
|
-
- E2E: Playwright, Cypress, or Selenium
|
|
431
|
-
- Component: Testing Library, Enzyme
|
|
432
|
-
|
|
433
|
-
**Python:**
|
|
434
|
-
- Unit/Integration: pytest, unittest
|
|
435
|
-
- E2E: Selenium, Playwright
|
|
436
|
-
- API: requests, httpx
|
|
437
|
-
|
|
438
|
-
**Go:**
|
|
439
|
-
- Unit/Integration: Built-in testing package, testify
|
|
440
|
-
- E2E: Selenium, Playwright
|
|
441
|
-
- HTTP: httptest package
|
|
442
|
-
|
|
443
|
-
## AI Assistant Integration
|
|
306
|
+
const agentsTemplated = require('agents-templated');
|
|
444
307
|
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
- `\ud83e\udd16 AGENTS.md` and `CLAUDE.md` (via workspace rules)
|
|
308
|
+
// Install all components
|
|
309
|
+
await agentsTemplated.install('./my-project', {
|
|
310
|
+
force: true
|
|
311
|
+
});
|
|
450
312
|
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
313
|
+
// Install specific components
|
|
314
|
+
await agentsTemplated.install('./my-project', {
|
|
315
|
+
docs: true,
|
|
316
|
+
rules: true,
|
|
317
|
+
skills: false,
|
|
318
|
+
github: true,
|
|
319
|
+
force: false
|
|
320
|
+
});
|
|
321
|
+
```
|
|
454
322
|
|
|
455
|
-
|
|
456
|
-
Reference `AI_INSTRUCTIONS.md` explicitly in your prompts:
|
|
457
|
-
- "Follow the patterns in `AI_INSTRUCTIONS.md`"
|
|
458
|
-
- "Check `AGENTS.md` for agent delegation"
|
|
459
|
-
- "Apply security patterns from `agents/rules/security.mdc`"
|
|
323
|
+
---
|
|
460
324
|
|
|
461
|
-
##
|
|
325
|
+
## 📝 Usage Examples
|
|
462
326
|
|
|
463
327
|
### Frontend Development
|
|
464
328
|
```
|
|
465
329
|
"Create a responsive navigation component with accessibility support"
|
|
466
|
-
"
|
|
467
|
-
"
|
|
330
|
+
"Implement dark mode toggle with user preference persistence"
|
|
331
|
+
"Build a data table with sorting, filtering, and pagination"
|
|
468
332
|
```
|
|
469
333
|
|
|
470
334
|
### Backend Development
|
|
471
335
|
```
|
|
472
|
-
"Create a secure user registration endpoint with rate limiting"
|
|
473
|
-
"Implement JWT authentication middleware"
|
|
336
|
+
"Create a secure user registration endpoint with email validation and rate limiting"
|
|
337
|
+
"Implement JWT authentication middleware with refresh tokens"
|
|
474
338
|
"Add password reset functionality with email verification"
|
|
475
339
|
```
|
|
476
340
|
|
|
477
341
|
### Database Operations
|
|
478
342
|
```
|
|
479
|
-
"Design a user roles and permissions schema"
|
|
480
|
-
"Create a migration to add
|
|
481
|
-
"Optimize the user query to prevent N+1 problems"
|
|
343
|
+
"Design a user roles and permissions schema with PostgreSQL"
|
|
344
|
+
"Create a migration to add full-text search to the posts table"
|
|
345
|
+
"Optimize the user query to prevent N+1 problems using joins"
|
|
482
346
|
```
|
|
483
347
|
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
### Getting Started
|
|
487
|
-
1. Review `CLAUDE.md` for architecture and technology selection guidance
|
|
488
|
-
2. Check `AGENTS.md` for agent responsibilities and delegation patterns
|
|
489
|
-
3. Reference `agents/rules/*.mdc` files for detailed implementation patterns
|
|
490
|
-
4. Configure your AI assistant using the appropriate configuration file
|
|
491
|
-
|
|
492
|
-
### Additional Resources
|
|
493
|
-
- **Architecture**: See `CLAUDE.md` for detailed architecture guidelines
|
|
494
|
-
- **Agent Usage**: See `AGENTS.md` for detailed agent responsibilities
|
|
495
|
-
- **Security**: See `agents/rules/security.mdc` for security patterns
|
|
496
|
-
- **Testing**: See `agents/rules/testing.mdc` for testing strategy
|
|
497
|
-
- **Code Style**: See `agents/rules/style.mdc` for formatting rules
|
|
498
|
-
|
|
499
|
-
## Quality Gates
|
|
500
|
-
|
|
501
|
-
All code must meet these standards:
|
|
502
|
-
- Pass linting and formatting checks
|
|
503
|
-
- Meet minimum test coverage thresholds (80% unit, 15% integration, 5% E2E)
|
|
504
|
-
- Pass security scans without high-severity issues
|
|
505
|
-
- Pass accessibility tests for user-facing features
|
|
506
|
-
- Follow established patterns and conventions
|
|
348
|
+
---
|
|
507
349
|
|
|
508
|
-
## Contributing
|
|
350
|
+
## 🤝 Contributing
|
|
509
351
|
|
|
510
352
|
When contributing to this template:
|
|
511
353
|
1. Maintain technology-agnostic patterns
|
|
@@ -514,6 +356,27 @@ When contributing to this template:
|
|
|
514
356
|
4. Follow security and testing patterns
|
|
515
357
|
5. Ensure AI assistant configurations remain compatible
|
|
516
358
|
|
|
359
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.
|
|
360
|
+
|
|
361
|
+
---
|
|
362
|
+
|
|
363
|
+
## 📖 License
|
|
364
|
+
|
|
365
|
+
MIT License - See [LICENSE](LICENSE) for details.
|
|
366
|
+
|
|
517
367
|
---
|
|
518
368
|
|
|
519
|
-
|
|
369
|
+
## 🔗 Links
|
|
370
|
+
|
|
371
|
+
- **NPM Package**: https://www.npmjs.com/package/agents-templated
|
|
372
|
+
- **GitHub Repository**: https://github.com/rickandrew2/agents-templated
|
|
373
|
+
- **Issues & Bug Reports**: https://github.com/rickandrew2/agents-templated/issues
|
|
374
|
+
- **Changelog**: [CHANGELOG.md](CHANGELOG.md)
|
|
375
|
+
|
|
376
|
+
---
|
|
377
|
+
|
|
378
|
+
**Ready to start building?** Choose your technology stack and begin development with enterprise-grade patterns from day one!
|
|
379
|
+
|
|
380
|
+
```bash
|
|
381
|
+
npx agents-templated@latest wizard
|
|
382
|
+
```
|