@aicgen/aicgen 1.1.0 → 1.2.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/.agents/plugins/marketplace.json +20 -0
- package/.codex/hooks/aicgen_session_start.py +16 -0
- package/.codex/hooks.json +25 -0
- package/.codex/instructions.md +8165 -0
- package/.gitmodules +2 -1
- package/AGENTS.md +43 -11
- package/README.md +83 -27
- package/claude.md +32 -3
- package/data/README.md +52 -14
- package/data/agentic/README.md +22 -0
- package/data/agentic/capabilities.yml +150 -0
- package/data/agentic/migration-gemini-to-antigravity.md +11 -0
- package/data/guideline-mappings.yml +0 -99
- package/data/version.json +3 -3
- package/data/workflows/README.md +22 -1
- package/data/workflows/sdlc.md +133 -0
- package/dist/index.js +14399 -13093
- package/jest.config.js +1 -0
- package/package.json +5 -6
- package/data/templates/hooks/testing.json +0 -17
package/.gitmodules
CHANGED
package/AGENTS.md
CHANGED
|
@@ -4,7 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
**Language:** typescript
|
|
6
6
|
**Type:** cli
|
|
7
|
-
**
|
|
7
|
+
**Instruction Level:** full
|
|
8
|
+
**Architecture:** layered
|
|
8
9
|
|
|
9
10
|
## Development Guidelines
|
|
10
11
|
|
|
@@ -16,11 +17,17 @@ This project follows structured coding guidelines across multiple categories:
|
|
|
16
17
|
- async
|
|
17
18
|
- interfaces-types
|
|
18
19
|
|
|
20
|
+
### Architecture
|
|
21
|
+
|
|
22
|
+
- boundaries
|
|
23
|
+
- communication
|
|
24
|
+
- data
|
|
25
|
+
|
|
19
26
|
### Testing
|
|
20
27
|
|
|
21
28
|
- unit-fundamentals
|
|
22
29
|
- unit-mocking
|
|
23
|
-
-
|
|
30
|
+
- integration
|
|
24
31
|
|
|
25
32
|
### Security
|
|
26
33
|
|
|
@@ -31,6 +38,7 @@ This project follows structured coding guidelines across multiple categories:
|
|
|
31
38
|
### Performance
|
|
32
39
|
|
|
33
40
|
- basics
|
|
41
|
+
- caching
|
|
34
42
|
- async
|
|
35
43
|
|
|
36
44
|
### API Design
|
|
@@ -49,15 +57,10 @@ This project follows structured coding guidelines across multiple categories:
|
|
|
49
57
|
- strategy
|
|
50
58
|
- basics
|
|
51
59
|
|
|
52
|
-
### Architecture
|
|
53
|
-
|
|
54
|
-
- principles
|
|
55
|
-
- messaging
|
|
56
|
-
- patterns
|
|
57
|
-
|
|
58
60
|
### DevOps
|
|
59
61
|
|
|
60
62
|
- ci-cd
|
|
63
|
+
- practices
|
|
61
64
|
- observability
|
|
62
65
|
|
|
63
66
|
### Best Practices
|
|
@@ -69,8 +72,8 @@ This project follows structured coding guidelines across multiple categories:
|
|
|
69
72
|
### Design Patterns
|
|
70
73
|
|
|
71
74
|
- base-patterns
|
|
75
|
+
- concurrency
|
|
72
76
|
- data-access
|
|
73
|
-
- domain-logic
|
|
74
77
|
|
|
75
78
|
|
|
76
79
|
## Commands
|
|
@@ -101,12 +104,28 @@ npm run build
|
|
|
101
104
|
See tool-specific instruction files for detailed code style guidelines:
|
|
102
105
|
- Claude Code: `CLAUDE.md`
|
|
103
106
|
- GitHub Copilot: `.github/copilot-instructions.md`
|
|
104
|
-
- Gemini: `.gemini/instructions.md`
|
|
105
107
|
- Antigravity: `.agent/rules/instructions.md`
|
|
108
|
+
- OpenAI Codex: `.codex/instructions.md`
|
|
106
109
|
|
|
107
110
|
## Architecture
|
|
108
111
|
|
|
109
|
-
This project follows **
|
|
112
|
+
This project follows **layered** architecture. See architecture guidelines in tool-specific files.
|
|
113
|
+
|
|
114
|
+
## Agentic Profile
|
|
115
|
+
|
|
116
|
+
**Profile level:** full
|
|
117
|
+
|
|
118
|
+
Enabled surfaces:
|
|
119
|
+
- Universal agent instructions: AGENTS.md (passive, stable)
|
|
120
|
+
- Codex skills: plugins/aicgen-sdlc/skills/*/SKILL.md (agentic, stable)
|
|
121
|
+
- Project-local plugin: plugins/aicgen-sdlc/.codex-plugin/plugin.json (agentic, stable)
|
|
122
|
+
- Lifecycle hooks: .codex/hooks.json (side-effecting, stable)
|
|
123
|
+
- MCP templates: .aicgen/mcp/codex.md (side-effecting, stable)
|
|
124
|
+
|
|
125
|
+
Limits and gated surfaces:
|
|
126
|
+
- No additional gated capabilities for this profile.
|
|
127
|
+
|
|
128
|
+
Side-effecting features such as hooks, MCP, plugin setup scripts, or executable tool configuration must stay local, deterministic, and explicitly reviewed before use.
|
|
110
129
|
|
|
111
130
|
## Testing
|
|
112
131
|
|
|
@@ -119,6 +138,19 @@ Follow testing guidelines in tool-specific instruction files.
|
|
|
119
138
|
- Run tests before pushing
|
|
120
139
|
- Keep PRs focused and reviewable
|
|
121
140
|
|
|
141
|
+
## Workflows
|
|
142
|
+
|
|
143
|
+
Use the project-local `aicgen-sdlc` Codex plugin for structured SDLC delivery:
|
|
144
|
+
|
|
145
|
+
Flow: `/aicgen-spec` → `/aicgen-research` → `/aicgen-plan` → `/aicgen-build` → `/aicgen-check` → `/aicgen-ship`
|
|
146
|
+
|
|
147
|
+
- `/aicgen-spec` — Capture the full specification for a feature or task before any code is written. (legacy aicgen `/spec`)
|
|
148
|
+
- `/aicgen-research` — Analyze the active spec with internal codebase scanning and external web research. (legacy aicgen `/research`)
|
|
149
|
+
- `/aicgen-plan` — Produce a phased, checkpoint-driven implementation plan based on the spec and research findings. (legacy aicgen `/plan`)
|
|
150
|
+
- `/aicgen-build` — Execute the next (or a specified) phase of the current implementation plan. (legacy aicgen `/build`)
|
|
151
|
+
- `/aicgen-check` — Verify the current implementation against the active spec — tests, code review, and regression check. (legacy aicgen `/check`)
|
|
152
|
+
- `/aicgen-ship` — Pre-flight wrap-up — verify everything is ready, then draft a PR description. (legacy aicgen `/ship`)
|
|
153
|
+
|
|
122
154
|
---
|
|
123
155
|
|
|
124
156
|
*Generated by aicgen - Universal AI agent instructions following the AGENTS.md standard*
|
package/README.md
CHANGED
|
@@ -7,23 +7,25 @@
|
|
|
7
7
|
</p>
|
|
8
8
|
|
|
9
9
|
<p align="center">
|
|
10
|
-
<img src="https://img.shields.io/badge/version-1.0
|
|
10
|
+
<img src="https://img.shields.io/badge/version-1.2.0-cyan" alt="Version" />
|
|
11
11
|
<img src="https://img.shields.io/badge/license-MIT-purple" alt="License" />
|
|
12
12
|
<img src="https://img.shields.io/badge/bun-%3E%3D1.0.0-cyan" alt="Bun" />
|
|
13
13
|
<img src="https://img.shields.io/github/actions/workflow/status/aicgen/aicgen/test.yml?branch=main&label=tests" alt="Tests" />
|
|
14
|
-
<img src="https://img.shields.io/badge/
|
|
14
|
+
<img src="https://img.shields.io/badge/tests-144-brightgreen" alt="Tests" />
|
|
15
15
|
</p>
|
|
16
16
|
|
|
17
17
|
---
|
|
18
18
|
|
|
19
|
-
**aicgen** makes your project AI-ready in seconds. Generate tailored instruction files for
|
|
19
|
+
**aicgen** makes your project AI-ready in seconds. Generate tailored instruction files, workflows, skills, and guarded agentic surfaces for the coding tools your team actually uses.
|
|
20
20
|
|
|
21
21
|
## ✨ Features
|
|
22
22
|
|
|
23
|
-
- **🎯 Multi-Assistant Support** - Claude Code, GitHub Copilot,
|
|
24
|
-
- **📚
|
|
23
|
+
- **🎯 Multi-Assistant Support** - Claude Code, GitHub Copilot, Antigravity, Codex
|
|
24
|
+
- **📚 99 Guidelines** - Organized into 12 categories (Language, Architecture, Testing, Security, etc.)
|
|
25
25
|
- **🎨 Interactive CLI** - Professional wizard with smart defaults and back navigation
|
|
26
|
-
- **⚡
|
|
26
|
+
- **⚡ Agentic Profiles** - Three progressive levels: `basic`, `standard`, and `full`
|
|
27
|
+
- **🔁 SDLC Workflows** - `/spec`, `/research`, `/plan`, `/build`, `/check`, and `/ship`
|
|
28
|
+
- **🧩 Codex SDLC Plugin** - Project-local `aicgen-sdlc` plugin with namespaced `/aicgen-*` skills
|
|
27
29
|
- **🏗️ Architecture Aware** - Supports Microservices, Modular Monoliths, Hexagonal, and more
|
|
28
30
|
- **📦 Zero External Dependencies** - All guideline data is embedded in the binary
|
|
29
31
|
|
|
@@ -39,7 +41,7 @@ The CLI will:
|
|
|
39
41
|
1. Detect your project language and structure
|
|
40
42
|
2. Guide you through assistant, architecture, and detail level selection
|
|
41
43
|
3. Let you customize which guidelines to include
|
|
42
|
-
4. Generate the appropriate config files (`.claude/`, `.github/`, `.agent/`,
|
|
44
|
+
4. Generate the appropriate config files (`.claude/`, `.github/`, `.agent/`, `.codex/`, `AGENTS.md`, and local plugin files)
|
|
43
45
|
|
|
44
46
|
---
|
|
45
47
|
|
|
@@ -89,6 +91,7 @@ sudo rpm -i aicgen_x86_64.rpm
|
|
|
89
91
|
```bash
|
|
90
92
|
git clone https://github.com/aicgen/aicgen.git
|
|
91
93
|
cd aicgen
|
|
94
|
+
git submodule update --init --recursive data
|
|
92
95
|
bun install
|
|
93
96
|
bun run build:binary
|
|
94
97
|
bun run start init
|
|
@@ -98,7 +101,19 @@ bun run start init
|
|
|
98
101
|
|
|
99
102
|
## 📚 Guideline System
|
|
100
103
|
|
|
101
|
-
aicgen uses a **modular guideline architecture** with **
|
|
104
|
+
aicgen uses a **modular guideline architecture** with **99 guidelines** organized into **12 categories**. Release builds embed content from the `data/` submodule, or from `AICGEN_DATA_DIR` when developing against a sibling `aicgen-data` checkout.
|
|
105
|
+
|
|
106
|
+
**Release 1.2.0 stats:**
|
|
107
|
+
|
|
108
|
+
| Metric | Count |
|
|
109
|
+
|--------|-------|
|
|
110
|
+
| Guidelines | 99 |
|
|
111
|
+
| SDLC workflows | 6 |
|
|
112
|
+
| Categories | 12 |
|
|
113
|
+
| Languages | 12 |
|
|
114
|
+
| Architectures | 10 |
|
|
115
|
+
| Datasources | 2 |
|
|
116
|
+
| Profile levels | `basic`, `standard`, `full` |
|
|
102
117
|
|
|
103
118
|
```bash
|
|
104
119
|
# View guideline statistics
|
|
@@ -106,7 +121,7 @@ aicgen stats
|
|
|
106
121
|
```
|
|
107
122
|
|
|
108
123
|
**Categories:**
|
|
109
|
-
- **Language** - TypeScript, Python, Go, Rust, Java, C#, Ruby,
|
|
124
|
+
- **Language** - TypeScript, JavaScript, Python, Go, Rust, Java, C#, Ruby, Dart, Swift, Kotlin, PHP
|
|
110
125
|
- **Architecture** - Layered, Modular Monolith, Microservices, Event-Driven, Hexagonal
|
|
111
126
|
- **DevOps** - CI/CD, Docker, Observability (Log formats, Metrics)
|
|
112
127
|
- **Best Practices** - SOLID, DRY, Clean Code principles
|
|
@@ -114,32 +129,62 @@ aicgen stats
|
|
|
114
129
|
|
|
115
130
|
## 📁 Generated Outputs
|
|
116
131
|
|
|
132
|
+
Profile levels control how much AICGEN generates:
|
|
133
|
+
|
|
134
|
+
| Level | Output |
|
|
135
|
+
|-------|--------|
|
|
136
|
+
| `basic` | Stable repo instructions and rules only |
|
|
137
|
+
| `standard` | Instructions plus guided workflows, prompt files, and Codex SDLC skills |
|
|
138
|
+
| `full` | Full agentic setup with skills, subagents, guardrail hooks, plugins, and MCP templates |
|
|
139
|
+
|
|
117
140
|
### For Claude Code
|
|
118
141
|
```text
|
|
119
142
|
CLAUDE.md # Master instructions (project root)
|
|
120
143
|
.claude/
|
|
121
|
-
├── settings.json #
|
|
144
|
+
├── settings.json # Guardrail hooks & permissions
|
|
122
145
|
├── guidelines/ # Modular guidelines
|
|
123
146
|
│ ├── language.md
|
|
124
147
|
│ ├── architecture.md
|
|
125
148
|
│ └── ...
|
|
126
|
-
|
|
127
|
-
|
|
149
|
+
├── agents/ # Sub-agents
|
|
150
|
+
│ └── guideline-checker.md
|
|
151
|
+
└── skills/ # Full profile project skills
|
|
128
152
|
```
|
|
129
153
|
|
|
130
154
|
### For GitHub Copilot
|
|
131
155
|
```text
|
|
132
156
|
.github/
|
|
133
157
|
├── copilot-instructions.md # Master instructions
|
|
134
|
-
|
|
158
|
+
├── instructions/ # Topic-specific files
|
|
159
|
+
├── prompts/ # Standard+ reusable prompt files
|
|
160
|
+
└── chatmodes/ # Full profile VS Code chat modes
|
|
135
161
|
```
|
|
136
162
|
|
|
137
|
-
### For
|
|
163
|
+
### For Antigravity
|
|
138
164
|
```text
|
|
139
|
-
.
|
|
140
|
-
|
|
165
|
+
.agent/
|
|
166
|
+
├── rules/
|
|
167
|
+
│ └── instructions.md # Workspace rule index
|
|
168
|
+
└── workflows/ # Profile-enabled workflows
|
|
141
169
|
```
|
|
142
170
|
|
|
171
|
+
### For Codex
|
|
172
|
+
```text
|
|
173
|
+
AGENTS.md # First-class Codex instructions
|
|
174
|
+
.codex/
|
|
175
|
+
├── instructions.md # Codex development guide
|
|
176
|
+
├── hooks.json # Full profile session reminder hook
|
|
177
|
+
└── hooks/ # Full profile hook scripts
|
|
178
|
+
.agents/
|
|
179
|
+
└── plugins/marketplace.json # Project-local plugin install entry
|
|
180
|
+
plugins/
|
|
181
|
+
└── aicgen-sdlc/ # SDLC lifecycle plugin
|
|
182
|
+
├── .codex-plugin/plugin.json
|
|
183
|
+
└── skills/aicgen-*/SKILL.md
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
> Gemini CLI generation has been removed from active assistant targets. Use Antigravity for Google-side agentic coding profiles.
|
|
187
|
+
|
|
143
188
|
---
|
|
144
189
|
|
|
145
190
|
## 🗺️ Roadmap
|
|
@@ -147,16 +192,16 @@ CLAUDE.md # Master instructions (project root)
|
|
|
147
192
|
### ✅ Completed
|
|
148
193
|
|
|
149
194
|
- [x] Interactive CLI wizard with back navigation
|
|
150
|
-
- [x] Multi-assistant support (Claude Code, Copilot,
|
|
151
|
-
- [x]
|
|
195
|
+
- [x] Multi-assistant support (Claude Code, Copilot, Antigravity, Codex)
|
|
196
|
+
- [x] 99 guidelines across 12 categories
|
|
152
197
|
- [x] Architecture-aware configuration (Layered, Modular Monolith, Microservices, etc.)
|
|
153
|
-
- [x]
|
|
198
|
+
- [x] Profile-gated agentic surfaces for workflows, skills, plugins, hooks, and MCP templates
|
|
154
199
|
- [x] Custom guideline management (add/remove)
|
|
155
200
|
- [x] GitHub-based guideline updates
|
|
156
201
|
|
|
157
202
|
### 🚧 Future Enhancements
|
|
158
203
|
|
|
159
|
-
- [ ] Custom
|
|
204
|
+
- [ ] Custom organization policy packs
|
|
160
205
|
- [ ] Guideline versioning and diffing
|
|
161
206
|
- [ ] Project-specific guideline templates
|
|
162
207
|
|
|
@@ -164,27 +209,38 @@ CLAUDE.md # Master instructions (project root)
|
|
|
164
209
|
|
|
165
210
|
### Running Tests
|
|
166
211
|
|
|
167
|
-
The project includes a comprehensive test suite with
|
|
212
|
+
The project includes a comprehensive test suite with 144 tests covering all core functionality:
|
|
168
213
|
|
|
169
214
|
```bash
|
|
215
|
+
# Check embedded instruction data is fresh
|
|
216
|
+
bun run check:embedded-data
|
|
217
|
+
|
|
218
|
+
# Validate the data submodule
|
|
219
|
+
data/scripts/validate-data
|
|
220
|
+
|
|
221
|
+
# Typecheck
|
|
222
|
+
bun run typecheck
|
|
223
|
+
|
|
170
224
|
# Run all tests
|
|
171
|
-
bun test
|
|
225
|
+
bun run test -- --runInBand
|
|
172
226
|
|
|
173
227
|
# Run tests with coverage report
|
|
174
|
-
bun test --
|
|
228
|
+
bun run test:coverage -- --runInBand
|
|
175
229
|
|
|
176
230
|
# Run tests in watch mode
|
|
177
|
-
bun test
|
|
231
|
+
bun run test:watch
|
|
178
232
|
```
|
|
179
233
|
|
|
180
234
|
### Test Coverage
|
|
181
235
|
|
|
182
|
-
Current
|
|
236
|
+
Current release validation: embedded data freshness, data schema validation, typecheck, Jest tests, and Bun build.
|
|
183
237
|
|
|
184
238
|
**Test Suite Includes:**
|
|
185
239
|
- ✅ GuidelineLoader tests (filtering, level selection, architecture handling)
|
|
186
240
|
- ✅ Tarball extraction tests (CONFIG-based prefix validation)
|
|
187
|
-
- ✅ AssistantFileWriter tests (
|
|
241
|
+
- ✅ AssistantFileWriter tests (Claude Code, Copilot, Antigravity, Codex)
|
|
242
|
+
- ✅ Agentic capability matrix and profile gating tests
|
|
243
|
+
- ✅ Codex project-local plugin generation tests
|
|
188
244
|
- ✅ File generation and path handling (cross-platform compatibility)
|
|
189
245
|
- ✅ Content validation and metadata inclusion
|
|
190
246
|
|
|
@@ -212,4 +268,4 @@ Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for det
|
|
|
212
268
|
|
|
213
269
|
## 📄 License
|
|
214
270
|
|
|
215
|
-
MIT ©
|
|
271
|
+
MIT © 2026
|
package/claude.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# my-project - Development Guidelines
|
|
2
2
|
|
|
3
|
-
**Role:** You are an expert software engineer specialized in typescript and
|
|
3
|
+
**Role:** You are an expert software engineer specialized in typescript and layered architecture.
|
|
4
4
|
**User's Goal:** Build high-quality, maintainable software following strict project guidelines.
|
|
5
5
|
|
|
6
6
|
## Guidelines
|
|
@@ -8,13 +8,13 @@
|
|
|
8
8
|
This project follows structured coding guidelines organized by category:
|
|
9
9
|
|
|
10
10
|
- **Language**: @.claude/guidelines/language.md
|
|
11
|
+
- **Architecture**: @.claude/guidelines/architecture.md
|
|
11
12
|
- **Testing**: @.claude/guidelines/testing.md
|
|
12
13
|
- **Security**: @.claude/guidelines/security.md
|
|
13
14
|
- **Performance**: @.claude/guidelines/performance.md
|
|
14
15
|
- **API Design**: @.claude/guidelines/api-design.md
|
|
15
16
|
- **Code Style**: @.claude/guidelines/code-style.md
|
|
16
17
|
- **Error Handling**: @.claude/guidelines/error-handling.md
|
|
17
|
-
- **Architecture**: @.claude/guidelines/architecture.md
|
|
18
18
|
- **DevOps**: @.claude/guidelines/devops.md
|
|
19
19
|
- **Best Practices**: @.claude/guidelines/best-practices.md
|
|
20
20
|
- **Design Patterns**: @.claude/guidelines/design-patterns.md
|
|
@@ -26,11 +26,40 @@ This project follows structured coding guidelines organized by category:
|
|
|
26
26
|
- Code style: See Code Style guidelines above
|
|
27
27
|
- Architecture: See Architecture guidelines above
|
|
28
28
|
|
|
29
|
+
## Workflows
|
|
30
|
+
|
|
31
|
+
Use these slash commands for structured SDLC delivery:
|
|
32
|
+
|
|
33
|
+
Flow: `/spec` → `/research` → `/plan` → `/build` → `/check` → `/ship`
|
|
34
|
+
|
|
35
|
+
- `/spec` — Capture the full specification for a feature or task before any code is written.
|
|
36
|
+
- `/research` — Analyze the active spec with internal codebase scanning and external web research.
|
|
37
|
+
- `/plan` — Produce a phased, checkpoint-driven implementation plan based on the spec and research findings.
|
|
38
|
+
- `/build` — Execute the next (or a specified) phase of the current implementation plan.
|
|
39
|
+
- `/check` — Verify the current implementation against the active spec — tests, code review, and regression check.
|
|
40
|
+
- `/ship` — Pre-flight wrap-up — verify everything is ready, then draft a PR description.
|
|
41
|
+
|
|
42
|
+
## Agentic Profile
|
|
43
|
+
|
|
44
|
+
**Profile level:** full
|
|
45
|
+
|
|
46
|
+
Enabled surfaces:
|
|
47
|
+
- Project memory: CLAUDE.md (passive, stable)
|
|
48
|
+
- Slash commands: .claude/commands/*.md (guided, stable)
|
|
49
|
+
- Project subagents: .claude/agents/*.md (agentic, stable)
|
|
50
|
+
- Project skills: .claude/skills/*/SKILL.md (agentic, stable)
|
|
51
|
+
- Lifecycle hooks: .claude/settings.json (side-effecting, stable)
|
|
52
|
+
|
|
53
|
+
Limits and gated surfaces:
|
|
54
|
+
- No additional gated capabilities for this profile.
|
|
55
|
+
|
|
56
|
+
Side-effecting features such as hooks, MCP, plugin setup scripts, or executable tool configuration must stay local, deterministic, and explicitly reviewed before use.
|
|
57
|
+
|
|
29
58
|
## Important Notes
|
|
30
59
|
|
|
31
60
|
- **Follow the guidelines** referenced above.
|
|
32
61
|
- **Verification**: Use sub-agents in `.claude/agents/` to verify compliance.
|
|
33
|
-
- **Constraints**: Hooks in `.claude/settings.json`
|
|
62
|
+
- **Constraints**: Hooks in `.claude/settings.json` provide deterministic guardrails; review them before extending.
|
|
34
63
|
|
|
35
64
|
---
|
|
36
65
|
*Generated by aicgen*
|
package/data/README.md
CHANGED
|
@@ -2,10 +2,22 @@
|
|
|
2
2
|
|
|
3
3
|
This repository contains coding guidelines and best practices that power aicgen configurations.
|
|
4
4
|
|
|
5
|
+
## Release 1.2.0 Stats
|
|
6
|
+
|
|
7
|
+
| Metric | Count |
|
|
8
|
+
|--------|-------|
|
|
9
|
+
| Guidelines | 99 |
|
|
10
|
+
| SDLC workflows | 6 |
|
|
11
|
+
| Categories | 12 |
|
|
12
|
+
| Languages | 12 |
|
|
13
|
+
| Architectures | 10 |
|
|
14
|
+
| Datasources | 2 |
|
|
15
|
+
| Profile levels | `basic`, `standard`, `full` |
|
|
16
|
+
|
|
5
17
|
## Directory Structure
|
|
6
18
|
|
|
7
19
|
```
|
|
8
|
-
data/
|
|
20
|
+
aicgen-data/
|
|
9
21
|
├── guideline-mappings.yml # Maps guideline IDs to files and filters
|
|
10
22
|
├── api/ # API design patterns
|
|
11
23
|
├── architecture/ # Architecture patterns (clean, DDD, etc.)
|
|
@@ -18,10 +30,26 @@ data/
|
|
|
18
30
|
├── practices/ # Best practices
|
|
19
31
|
├── security/ # Security guidelines
|
|
20
32
|
├── style/ # Code style guidelines
|
|
33
|
+
├── agentic/ # Assistant capability matrix and profile limits
|
|
21
34
|
├── templates/ # Reusable templates
|
|
35
|
+
├── workflows/ # SDLC lifecycle command definitions
|
|
22
36
|
└── testing/ # Testing strategies
|
|
23
37
|
```
|
|
24
38
|
|
|
39
|
+
## Agentic Profiles
|
|
40
|
+
|
|
41
|
+
The `agentic/` directory describes how guideline content maps into assistant-specific surfaces for Claude Code, GitHub Copilot, Antigravity, and Codex.
|
|
42
|
+
|
|
43
|
+
Gemini CLI generation is removed from active targets. Use Antigravity for Google-side agentic coding profiles.
|
|
44
|
+
|
|
45
|
+
Profile levels gate capability risk:
|
|
46
|
+
|
|
47
|
+
- `basic`: stable instructions and rules.
|
|
48
|
+
- `standard`: reusable workflows, prompt files, and stable Codex SDLC skills.
|
|
49
|
+
- `full`: focused agents, skills, safe lifecycle guardrail hooks, plugin packaging, and advanced documentation templates such as MCP.
|
|
50
|
+
|
|
51
|
+
Test-suite execution is handled by the `/check` lifecycle command, not by generated hooks. Hook templates must not run full test suites automatically.
|
|
52
|
+
|
|
25
53
|
## Contributing Guidelines
|
|
26
54
|
|
|
27
55
|
### Step 1: Create Your Guideline File
|
|
@@ -30,7 +58,7 @@ Create a markdown file in the appropriate category folder:
|
|
|
30
58
|
|
|
31
59
|
```bash
|
|
32
60
|
# Example: Adding a new TypeScript guideline
|
|
33
|
-
data/language/typescript/my-guideline.md
|
|
61
|
+
aicgen-data/language/typescript/my-guideline.md
|
|
34
62
|
```
|
|
35
63
|
|
|
36
64
|
**Guideline Format:**
|
|
@@ -79,7 +107,6 @@ my-guideline-id:
|
|
|
79
107
|
- typescript
|
|
80
108
|
levels:
|
|
81
109
|
- standard
|
|
82
|
-
- expert
|
|
83
110
|
- full
|
|
84
111
|
tags:
|
|
85
112
|
- typescript
|
|
@@ -93,24 +120,24 @@ my-guideline-id:
|
|
|
93
120
|
| `path` | Yes | Relative path to the guideline file |
|
|
94
121
|
| `category` | Yes | Display category (Language, Architecture, Testing, etc.) |
|
|
95
122
|
| `languages` | No | Which languages this applies to. Omit for all languages |
|
|
96
|
-
| `levels` | No | Instruction levels: `basic`, `standard`, `
|
|
123
|
+
| `levels` | No | Instruction levels: `basic`, `standard`, `full`. Omit for all |
|
|
97
124
|
| `architectures` | No | Architecture types. Omit for all |
|
|
98
125
|
| `tags` | No | Search/organization tags |
|
|
99
126
|
|
|
100
127
|
### Available Values
|
|
101
128
|
|
|
102
129
|
**Languages:**
|
|
103
|
-
- `typescript`, `python`, `go`, `rust`, `java`, `csharp`, `ruby`, `
|
|
130
|
+
- `typescript`, `javascript`, `python`, `go`, `rust`, `java`, `csharp`, `ruby`, `dart`, `swift`, `kotlin`, `php`
|
|
104
131
|
|
|
105
132
|
**Levels:**
|
|
106
133
|
- `basic` - Essential guidelines only
|
|
107
134
|
- `standard` - Common best practices
|
|
108
|
-
- `
|
|
109
|
-
- `full` - Comprehensive coverage
|
|
135
|
+
- `full` - Comprehensive coverage with advanced agentic surfaces
|
|
110
136
|
|
|
111
137
|
**Architectures:**
|
|
112
138
|
- `layered`, `clean-architecture`, `hexagonal`, `ddd`, `microservices`
|
|
113
|
-
- `modular-monolith`, `event-driven`, `serverless`, `
|
|
139
|
+
- `modular-monolith`, `event-driven`, `serverless`, `monorepo`
|
|
140
|
+
- `bounded-contexts`, `component-based`
|
|
114
141
|
|
|
115
142
|
**Categories:**
|
|
116
143
|
- `Language`, `Architecture`, `Testing`, `Security`, `Performance`
|
|
@@ -128,7 +155,6 @@ typescript-decorators:
|
|
|
128
155
|
languages:
|
|
129
156
|
- typescript
|
|
130
157
|
levels:
|
|
131
|
-
- expert
|
|
132
158
|
- full
|
|
133
159
|
tags:
|
|
134
160
|
- typescript
|
|
@@ -144,7 +170,6 @@ solid-principles:
|
|
|
144
170
|
category: Architecture
|
|
145
171
|
levels:
|
|
146
172
|
- standard
|
|
147
|
-
- expert
|
|
148
173
|
- full
|
|
149
174
|
tags:
|
|
150
175
|
- solid
|
|
@@ -162,7 +187,6 @@ ddd-aggregates:
|
|
|
162
187
|
- ddd
|
|
163
188
|
- clean-architecture
|
|
164
189
|
levels:
|
|
165
|
-
- expert
|
|
166
190
|
- full
|
|
167
191
|
tags:
|
|
168
192
|
- ddd
|
|
@@ -174,17 +198,31 @@ ddd-aggregates:
|
|
|
174
198
|
|
|
175
199
|
After adding a guideline:
|
|
176
200
|
|
|
177
|
-
1. **
|
|
201
|
+
1. **Validate the data repo:**
|
|
178
202
|
```bash
|
|
203
|
+
scripts/validate-data
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
2. **Rebuild aicgen:**
|
|
207
|
+
```bash
|
|
208
|
+
AICGEN_DATA_DIR=/path/to/aicgen-data bun run embed
|
|
179
209
|
bun run build
|
|
180
210
|
```
|
|
181
211
|
|
|
182
|
-
|
|
212
|
+
3. **Check it's loaded:**
|
|
183
213
|
```bash
|
|
184
214
|
bun run start stats
|
|
185
215
|
```
|
|
186
216
|
|
|
187
|
-
|
|
217
|
+
Expected 1.2.0 level stats:
|
|
218
|
+
|
|
219
|
+
```text
|
|
220
|
+
basic: 23
|
|
221
|
+
standard: 83
|
|
222
|
+
full: 99
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
4. **Test generation:**
|
|
188
226
|
```bash
|
|
189
227
|
bun run start init --force
|
|
190
228
|
```
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Agentic Capability Profiles
|
|
2
|
+
|
|
3
|
+
This directory documents how AICGEN maps reusable guideline content into modern AI coding tool surfaces.
|
|
4
|
+
|
|
5
|
+
Gemini CLI is no longer an active generated target. Use Antigravity for Google-side agentic coding profiles.
|
|
6
|
+
|
|
7
|
+
## Profile Levels
|
|
8
|
+
|
|
9
|
+
- `basic`: main repository instructions and stable rule files only.
|
|
10
|
+
- `standard`: basic output plus reusable workflows, commands, and prompt files.
|
|
11
|
+
- `full`: standard output plus focused agents, skills, guardrail hooks, plugin packaging, and advanced integration templates such as MCP.
|
|
12
|
+
|
|
13
|
+
Validation stays in the lifecycle commands: `/check` is responsible for running or asking for the relevant test suite. Generated hooks should never invoke full test suites automatically.
|
|
14
|
+
|
|
15
|
+
## Risk Levels
|
|
16
|
+
|
|
17
|
+
- `passive`: instructions or rules only.
|
|
18
|
+
- `guided`: reusable prompts, commands, or workflows that users invoke.
|
|
19
|
+
- `agentic`: subagents, skills, or plugin-packaged behavior selected by the assistant.
|
|
20
|
+
- `side-effecting`: hooks, MCP, setup scripts, or executable tool configuration.
|
|
21
|
+
|
|
22
|
+
Side-effecting capabilities must stay local, deterministic, and explicitly reviewed before use.
|