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