@namch/agent-assistant 1.3.0 → 1.3.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/CHANGELOG.md +11 -1
- package/agents/backend-engineer.md +3 -3
- package/agents/brainstormer.md +3 -3
- package/agents/business-analyst.md +3 -3
- package/agents/database-architect.md +3 -3
- package/agents/debugger.md +2 -2
- package/agents/designer.md +2 -2
- package/agents/devops-engineer.md +2 -2
- package/agents/docs-manager.md +23 -15
- package/agents/frontend-engineer.md +3 -3
- package/agents/game-engineer.md +3 -3
- package/agents/mobile-engineer.md +4 -4
- package/agents/performance-engineer.md +3 -3
- package/agents/planner.md +4 -4
- package/agents/project-manager.md +3 -3
- package/agents/researcher.md +3 -3
- package/agents/reviewer.md +3 -3
- package/agents/scouter.md +3 -3
- package/agents/security-engineer.md +3 -3
- package/agents/tech-lead.md +3 -3
- package/agents/tester.md +2 -2
- package/commands/docs/audit.md +554 -78
- package/commands/docs/business.md +392 -76
- package/commands/docs/core.md +573 -74
- package/commands/docs.md +62 -61
- package/documents/business/business-features/00-index.md +101 -0
- package/documents/business/business-features/01-feature-inventory.md +341 -0
- package/documents/business/business-features/02-prioritization-moscow.md +148 -0
- package/documents/business/business-features/03-feature-specifications.md +512 -0
- package/documents/business/business-features/04-dependencies-and-release-sequencing.md +313 -0
- package/documents/business/business-features/05-success-metrics.md +290 -0
- package/documents/business/business-glossary/00-index.md +89 -0
- package/documents/business/business-glossary/01-canonical-terms.md +428 -0
- package/documents/business/business-glossary/02-synonyms-and-deprecated-terms.md +180 -0
- package/documents/business/business-glossary/03-domain-entities-and-events.md +395 -0
- package/documents/business/business-glossary/04-api-term-mapping.md +173 -0
- package/documents/business/business-prd/00-index.md +107 -0
- package/documents/business/business-prd/01-executive-summary.md +131 -0
- package/documents/business/business-prd/02-problem-goals-and-scope.md +204 -0
- package/documents/business/business-prd/03-stakeholders-and-requirements.md +210 -0
- package/documents/business/business-prd/04-acceptance-risks-assumptions.md +246 -0
- package/documents/business/business-workflows/00-index.md +107 -0
- package/documents/business/business-workflows/01-actor-map.md +303 -0
- package/documents/business/business-workflows/02-workflow-catalog.md +252 -0
- package/documents/business/business-workflows/03-detailed-workflows.md +641 -0
- package/documents/business/business-workflows/04-decision-rules-and-exceptions.md +216 -0
- package/documents/business/business-workflows/05-sla-and-handoffs.md +253 -0
- package/documents/knowledge-architecture/00-index.md +159 -0
- package/documents/knowledge-architecture/01-system-overview.md +240 -0
- package/documents/knowledge-architecture/02-components.md +419 -0
- package/documents/knowledge-architecture/03-data-flow.md +369 -0
- package/documents/knowledge-architecture/04-design-patterns.md +498 -0
- package/documents/knowledge-architecture/05-decisions.md +410 -0
- package/documents/knowledge-domain/00-index.md +251 -0
- package/documents/knowledge-domain/01-entities.md +583 -0
- package/documents/knowledge-domain/02-database-schema.md +138 -0
- package/documents/knowledge-domain/03-api-contracts.md +479 -0
- package/documents/knowledge-domain/04-business-rules.md +555 -0
- package/documents/knowledge-overview/00-index.md +107 -0
- package/documents/knowledge-overview/01-project-identity.md +162 -0
- package/documents/knowledge-overview/02-tech-stack.md +119 -0
- package/documents/knowledge-overview/03-features.md +233 -0
- package/documents/knowledge-overview/04-getting-started.md +394 -0
- package/documents/knowledge-source-base/00-index.md +107 -0
- package/documents/knowledge-source-base/01-directory-structure.md +312 -0
- package/documents/knowledge-source-base/02-entry-points.md +346 -0
- package/documents/knowledge-source-base/03-key-modules.md +582 -0
- package/documents/knowledge-source-base/04-configuration.md +467 -0
- package/documents/knowledge-standards/00-index.md +129 -0
- package/documents/knowledge-standards/01-code-style.md +161 -0
- package/documents/knowledge-standards/02-conventions.md +255 -0
- package/documents/knowledge-standards/03-git-workflow.md +228 -0
- package/documents/knowledge-standards/04-testing-standards.md +175 -0
- package/package.json +1 -1
- package/rules/REFERENCE.md +10 -6
- package/skills/docs-audit/README.md +10 -8
- package/skills/docs-audit/SKILL.md +45 -41
- package/skills/docs-audit/references/scoring-framework.md +5 -5
- package/skills/docs-core/README.md +19 -14
- package/skills/docs-core/SKILL.md +189 -117
- package/skills/planning/references/codebase-understanding.md +5 -5
- package/documents/business/business-features.md +0 -894
- package/documents/business/business-glossary.md +0 -554
- package/documents/business/business-prd.md +0 -400
- package/documents/business/business-workflows.md +0 -713
- package/documents/knowledge-architecture.md +0 -621
- package/documents/knowledge-domain.md +0 -602
- package/documents/knowledge-overview.md +0 -316
- package/documents/knowledge-source-base.md +0 -581
- package/documents/knowledge-standards.md +0 -632
|
@@ -0,0 +1,467 @@
|
|
|
1
|
+
# Agent Assistant — Configuration
|
|
2
|
+
|
|
3
|
+
> **Purpose**: Complete inventory of all configuration files, environment variables, and secrets management across the framework and web sub-project
|
|
4
|
+
> **Parent**: [00-index.md](./00-index.md)
|
|
5
|
+
> **Last Updated**: 2026-03-26
|
|
6
|
+
> **Generated By**: docs-core skill
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## Table of Contents
|
|
11
|
+
|
|
12
|
+
- [Overview](#overview)
|
|
13
|
+
- [Root Package Configuration](#root-package-configuration)
|
|
14
|
+
- [Release Configuration](#release-configuration)
|
|
15
|
+
- [Git Configuration](#git-configuration)
|
|
16
|
+
- [Git Hooks](#git-hooks)
|
|
17
|
+
- [HSOL Configuration](#hsol-configuration)
|
|
18
|
+
- [Web Application Configuration](#web-application-configuration)
|
|
19
|
+
- [Platform-Specific Configuration](#platform-specific-configuration)
|
|
20
|
+
- [Environment Variables](#environment-variables)
|
|
21
|
+
- [Secrets Management](#secrets-management)
|
|
22
|
+
- [Configuration Hierarchy](#configuration-hierarchy)
|
|
23
|
+
- [Evidence Sources](#evidence-sources)
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## Overview
|
|
28
|
+
|
|
29
|
+
Agent Assistant uses two distinct configuration layers:
|
|
30
|
+
|
|
31
|
+
1. **Tooling Config** — Standard Node.js/npm/Vite config files for building, linting, releasing, and deploying
|
|
32
|
+
2. **Framework Config** — YAML and Markdown files that configure the AI orchestration behavior (HSOL, rules, agents)
|
|
33
|
+
|
|
34
|
+
The project has zero production dependencies. All config files serve either the CLI installer, the release pipeline, or the marketing website.
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## Root Package Configuration
|
|
39
|
+
|
|
40
|
+
### package.json
|
|
41
|
+
|
|
42
|
+
| Field | Value | Purpose |
|
|
43
|
+
|-------|-------|---------|
|
|
44
|
+
| `name` | `@namch/agent-assistant` | Scoped npm package name |
|
|
45
|
+
| `version` | `1.3.0` | Current version (managed by semantic-release) |
|
|
46
|
+
| `description` | Multi-agent orchestration framework... | npm registry description |
|
|
47
|
+
| `main` | `cli/install.js` | Default module entry for `require()` |
|
|
48
|
+
| `bin.agent-assistant` | `./cli/install.js` | CLI binary name for `npx` invocation |
|
|
49
|
+
| `engines.node` | `>=18.0.0` | Minimum Node.js version constraint |
|
|
50
|
+
| `license` | `MIT` | Open source license |
|
|
51
|
+
| `author` | `NamCH` | Package author |
|
|
52
|
+
| `publishConfig.access` | `public` | npm publish visibility |
|
|
53
|
+
|
|
54
|
+
### files Array (Published Contents)
|
|
55
|
+
|
|
56
|
+
Defines exactly what gets included in the npm tarball:
|
|
57
|
+
|
|
58
|
+
```json
|
|
59
|
+
[
|
|
60
|
+
"cli/",
|
|
61
|
+
"agents/",
|
|
62
|
+
"commands/",
|
|
63
|
+
"rules/",
|
|
64
|
+
"matrix-skills/",
|
|
65
|
+
"skills/",
|
|
66
|
+
"documents/",
|
|
67
|
+
"code-assistants/",
|
|
68
|
+
"LICENSE",
|
|
69
|
+
"README.md",
|
|
70
|
+
"CHANGELOG.md"
|
|
71
|
+
]
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
**Notably excluded** from npm package:
|
|
75
|
+
- `web/` — Marketing site (independent deployment)
|
|
76
|
+
- `AGENT.md`, `CLAUDE.md`, `COPILOT.md`, `CURSOR.md`, `CODEX.md`, `GEMINI.md` — Root platform files (exist in repo but only the `code-assistants/` versions are published)
|
|
77
|
+
- `AGENT-TEMPLATE.md` — Developer reference only
|
|
78
|
+
- `.releaserc.json`, `.husky/`, `.gitignore` — Development tooling
|
|
79
|
+
|
|
80
|
+
### scripts
|
|
81
|
+
|
|
82
|
+
| Script | Command | Category |
|
|
83
|
+
|--------|---------|----------|
|
|
84
|
+
| `install:cursor` | `node cli/install.js install cursor` | Platform install |
|
|
85
|
+
| `install:copilot` | `node cli/install.js install copilot` | Platform install |
|
|
86
|
+
| `install:antigravity` | `node cli/install.js install antigravity` | Platform install |
|
|
87
|
+
| `install:codex` | `node cli/install.js install codex` | Platform install |
|
|
88
|
+
| `install:all` | `node cli/install.js install --all` | Batch install |
|
|
89
|
+
| `uninstall:cursor` | `node cli/install.js uninstall cursor` | Platform uninstall |
|
|
90
|
+
| `uninstall:copilot` | `node cli/install.js uninstall copilot` | Platform uninstall |
|
|
91
|
+
| `uninstall:antigravity` | `node cli/install.js uninstall antigravity` | Platform uninstall |
|
|
92
|
+
| `uninstall:codex` | `node cli/install.js uninstall codex` | Platform uninstall |
|
|
93
|
+
| `uninstall:all` | `node cli/install.js uninstall --all` | Batch uninstall |
|
|
94
|
+
| `list` | `node cli/install.js list` | Status check |
|
|
95
|
+
| `test` | `node --test cli/*.test.js` | Testing |
|
|
96
|
+
| `lint` | `node --check cli/install.js && echo '✅ JavaScript syntax valid'` | Syntax validation |
|
|
97
|
+
| `lint:md` | `echo 'Run: npx markdownlint ...'` | Informational |
|
|
98
|
+
| `semantic-release` | `semantic-release` | Release automation |
|
|
99
|
+
| `prepare` | `husky install \|\| true` | Git hooks setup |
|
|
100
|
+
|
|
101
|
+
### devDependencies
|
|
102
|
+
|
|
103
|
+
| Package | Version | Purpose |
|
|
104
|
+
|---------|---------|---------|
|
|
105
|
+
| `@semantic-release/changelog` | ^6.0.3 | Generate CHANGELOG.md entries |
|
|
106
|
+
| `@semantic-release/commit-analyzer` | ^11.1.0 | Analyze commits for version bumps |
|
|
107
|
+
| `@semantic-release/exec` | ^6.0.3 | Execute custom commands during release |
|
|
108
|
+
| `@semantic-release/git` | ^10.0.1 | Commit version files back to repo |
|
|
109
|
+
| `@semantic-release/github` | ^9.2.6 | Create GitHub releases |
|
|
110
|
+
| `@semantic-release/npm` | ^11.0.2 | Publish to npm registry |
|
|
111
|
+
| `@semantic-release/release-notes-generator` | ^12.1.0 | Generate release notes from commits |
|
|
112
|
+
| `conventional-changelog-conventionalcommits` | ^7.0.2 | Conventional commits changelog preset |
|
|
113
|
+
| `husky` | ^8.0.3 | Git hooks framework |
|
|
114
|
+
| `semantic-release` | ^22.0.12 | Core release automation engine |
|
|
115
|
+
|
|
116
|
+
---
|
|
117
|
+
|
|
118
|
+
## Release Configuration
|
|
119
|
+
|
|
120
|
+
### .releaserc.json
|
|
121
|
+
|
|
122
|
+
**Branch**: `main` (single release branch)
|
|
123
|
+
|
|
124
|
+
**Plugin Pipeline** (executed in order):
|
|
125
|
+
|
|
126
|
+
| Step | Plugin | Configuration |
|
|
127
|
+
|------|--------|---------------|
|
|
128
|
+
| 1. Analyze | `@semantic-release/commit-analyzer` | Preset: `conventionalcommits` |
|
|
129
|
+
| 2. Notes | `@semantic-release/release-notes-generator` | Preset: `conventionalcommits` with section grouping |
|
|
130
|
+
| 3. Changelog | `@semantic-release/changelog` | Output: `CHANGELOG.md` |
|
|
131
|
+
| 4. npm | `@semantic-release/npm` | Publishes to npm (uses `publishConfig.access: public`) |
|
|
132
|
+
| 5. Git | `@semantic-release/git` | Commits `CHANGELOG.md` + `package.json`, message: `chore(release): ${nextRelease.version} [skip ci]` |
|
|
133
|
+
| 6. GitHub | `@semantic-release/github` | Creates GitHub release with notes |
|
|
134
|
+
|
|
135
|
+
**Release Rules**:
|
|
136
|
+
|
|
137
|
+
| Commit Type | Release | Changelog Section |
|
|
138
|
+
|-------------|---------|-------------------|
|
|
139
|
+
| `feat` | minor | Features |
|
|
140
|
+
| `fix` | patch | Bug Fixes |
|
|
141
|
+
| `perf` | patch | Performance |
|
|
142
|
+
| `refactor` | patch | Refactoring |
|
|
143
|
+
| `docs` (scope: README) | patch | Documentation |
|
|
144
|
+
| `chore` | none | (hidden) |
|
|
145
|
+
| `style` | none | (hidden) |
|
|
146
|
+
| `test` | none | (hidden) |
|
|
147
|
+
| `breaking: true` | **major** | (in respective section) |
|
|
148
|
+
|
|
149
|
+
---
|
|
150
|
+
|
|
151
|
+
## Git Configuration
|
|
152
|
+
|
|
153
|
+
### .gitignore
|
|
154
|
+
|
|
155
|
+
```gitignore
|
|
156
|
+
# Build outputs
|
|
157
|
+
out
|
|
158
|
+
dist
|
|
159
|
+
*.vsix
|
|
160
|
+
.vscode-test
|
|
161
|
+
|
|
162
|
+
# Dependencies
|
|
163
|
+
node_modules
|
|
164
|
+
|
|
165
|
+
# OS files
|
|
166
|
+
.DS_Store
|
|
167
|
+
Thumbs.db
|
|
168
|
+
|
|
169
|
+
# Environment files
|
|
170
|
+
.env
|
|
171
|
+
.env.*
|
|
172
|
+
!.env.example
|
|
173
|
+
|
|
174
|
+
# Generated reports (user-specific)
|
|
175
|
+
reports/
|
|
176
|
+
|
|
177
|
+
# Logs
|
|
178
|
+
*.log
|
|
179
|
+
npm-debug.log*
|
|
180
|
+
|
|
181
|
+
# Coverage
|
|
182
|
+
coverage/
|
|
183
|
+
.nyc_output/
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
Key exclusions:
|
|
187
|
+
- `.env` and `.env.*` (except `.env.example`) — prevents secrets from being committed
|
|
188
|
+
- `reports/` — user-generated report output from commands like `/report`
|
|
189
|
+
- `dist/` — build artifacts
|
|
190
|
+
- `node_modules/` — dependencies
|
|
191
|
+
|
|
192
|
+
---
|
|
193
|
+
|
|
194
|
+
## Git Hooks
|
|
195
|
+
|
|
196
|
+
### .husky/
|
|
197
|
+
|
|
198
|
+
The `.husky/` directory contains a `_/` subdirectory (husky internal). The `prepare` script in `package.json` runs `husky install || true` with `|| true` to gracefully handle CI environments where husky installation is not needed.
|
|
199
|
+
|
|
200
|
+
---
|
|
201
|
+
|
|
202
|
+
## HSOL Configuration
|
|
203
|
+
|
|
204
|
+
### matrix-skills/_index.yaml
|
|
205
|
+
|
|
206
|
+
The central config for the Hybrid Skill Orchestration Layer:
|
|
207
|
+
|
|
208
|
+
| Key | Value | Purpose |
|
|
209
|
+
|-----|-------|---------|
|
|
210
|
+
| `version` | `"1.1"` | HSOL protocol version |
|
|
211
|
+
| `last_updated` | `"2026-01-30"` | Last registry update date |
|
|
212
|
+
| `total_matrix_skills` | `1430` | Total curated skills across all domains |
|
|
213
|
+
| `hsol.enabled` | `true` | HSOL is active |
|
|
214
|
+
| `hsol.version` | `"1.1"` | HSOL engine version |
|
|
215
|
+
| `hsol.find_skills.skill_path` | `"{SKILLS_PATH}/find-skills/SKILL.md"` | Path to discovery skill |
|
|
216
|
+
| `hsol.find_skills.browse_url` | `"https://skills.sh/"` | External skill marketplace URL |
|
|
217
|
+
| `hsol.find_skills.cli_commands.search` | `"npx skills find [query]"` | Search for skills |
|
|
218
|
+
| `hsol.find_skills.cli_commands.install` | `"npx skills add <owner/repo@skill> -g -y"` | Install skill globally for current tool |
|
|
219
|
+
| `hsol.find_skills.cli_commands.check` | `"npx skills check"` | Check installed skills |
|
|
220
|
+
| `hsol.find_skills.cli_commands.update` | `"npx skills update"` | Update installed skills |
|
|
221
|
+
| `hsol.dynamic_manifest` | `"_dynamic.yaml"` | Dynamic skill manifest file |
|
|
222
|
+
| `hsol.discovery.enabled` | `true` | Dynamic discovery is active |
|
|
223
|
+
| `hsol.discovery.timeout_ms` | `5000` | Discovery request timeout |
|
|
224
|
+
| `hsol.discovery.cache_ttl_seconds` | `3600` | Cache duration (1 hour) |
|
|
225
|
+
| `hsol.discovery.async_threshold` | `0.8` | Skip discovery if matrix fitness exceeds this |
|
|
226
|
+
| `hsol.discovery.apply_for_variants` | `["hard", "focus"]` | Only run discovery for these variants; `fast` skips it |
|
|
227
|
+
|
|
228
|
+
### matrix-skills/_dynamic.yaml
|
|
229
|
+
|
|
230
|
+
Community-installed skill manifest. Populated via `npx skills add` commands. Not pre-filled in the repository.
|
|
231
|
+
|
|
232
|
+
### 19 Domain Registry Files
|
|
233
|
+
|
|
234
|
+
Each domain YAML file maps a set of skills from the `skills/` directory with priority and relevance metadata. Domains: `ai-ml`, `architecture`, `backend`, `cloud`, `data`, `design`, `devops`, `frontend`, `gaming`, `languages`, `management`, `mcp`, `mobile`, `performance`, `planning`, `quality`, `research`, `security`, `tools`.
|
|
235
|
+
|
|
236
|
+
---
|
|
237
|
+
|
|
238
|
+
## Web Application Configuration
|
|
239
|
+
|
|
240
|
+
### web/package.json
|
|
241
|
+
|
|
242
|
+
| Field | Value |
|
|
243
|
+
|-------|-------|
|
|
244
|
+
| `name` | `web` |
|
|
245
|
+
| `private` | `true` |
|
|
246
|
+
| `version` | `0.0.0` |
|
|
247
|
+
| `type` | `module` (ESM) |
|
|
248
|
+
|
|
249
|
+
**Scripts**:
|
|
250
|
+
| Script | Command |
|
|
251
|
+
|--------|---------|
|
|
252
|
+
| `dev` | `vite` |
|
|
253
|
+
| `build` | `tsc -b && vite build` |
|
|
254
|
+
| `lint` | `eslint .` |
|
|
255
|
+
| `preview` | `vite preview` |
|
|
256
|
+
|
|
257
|
+
### web/vite.config.ts
|
|
258
|
+
|
|
259
|
+
```typescript
|
|
260
|
+
import { defineConfig } from 'vite'
|
|
261
|
+
import react from '@vitejs/plugin-react'
|
|
262
|
+
import tailwindcss from '@tailwindcss/vite'
|
|
263
|
+
|
|
264
|
+
export default defineConfig({
|
|
265
|
+
plugins: [react(), tailwindcss()],
|
|
266
|
+
build: {
|
|
267
|
+
target: 'esnext',
|
|
268
|
+
minify: 'esbuild',
|
|
269
|
+
rollupOptions: {
|
|
270
|
+
output: {
|
|
271
|
+
manualChunks: {
|
|
272
|
+
'react-vendor': ['react', 'react-dom', 'react-router-dom'],
|
|
273
|
+
'animation-vendor': ['framer-motion'],
|
|
274
|
+
}
|
|
275
|
+
}
|
|
276
|
+
}
|
|
277
|
+
},
|
|
278
|
+
// ... resolve.alias config
|
|
279
|
+
})
|
|
280
|
+
```
|
|
281
|
+
|
|
282
|
+
**Key settings**:
|
|
283
|
+
- **Build target**: `esnext` (modern browsers only)
|
|
284
|
+
- **Minifier**: `esbuild` (fastest)
|
|
285
|
+
- **Code splitting**: Two manual chunks to optimize caching
|
|
286
|
+
|
|
287
|
+
### web/tsconfig.json
|
|
288
|
+
|
|
289
|
+
Project references configuration:
|
|
290
|
+
```json
|
|
291
|
+
{
|
|
292
|
+
"files": [],
|
|
293
|
+
"references": [
|
|
294
|
+
{ "path": "./tsconfig.app.json" },
|
|
295
|
+
{ "path": "./tsconfig.node.json" }
|
|
296
|
+
]
|
|
297
|
+
}
|
|
298
|
+
```
|
|
299
|
+
|
|
300
|
+
### web/tsconfig.app.json
|
|
301
|
+
|
|
302
|
+
| Option | Value | Purpose |
|
|
303
|
+
|--------|-------|---------|
|
|
304
|
+
| `target` | `ES2022` | Output JavaScript version |
|
|
305
|
+
| `module` | `ESNext` | Module system |
|
|
306
|
+
| `moduleResolution` | `bundler` | Vite-compatible resolution |
|
|
307
|
+
| `jsx` | `react-jsx` | React 19 JSX transform |
|
|
308
|
+
| `lib` | `["ES2022", "DOM", "DOM.Iterable"]` | Type libraries |
|
|
309
|
+
| `noEmit` | `true` | Type-check only (Vite handles output) |
|
|
310
|
+
| `types` | `["vite/client"]` | Vite-specific type definitions |
|
|
311
|
+
| `verbatimModuleSyntax` | `true` | Strict import/export syntax |
|
|
312
|
+
|
|
313
|
+
### web/eslint.config.js
|
|
314
|
+
|
|
315
|
+
ESLint v9 flat config:
|
|
316
|
+
- Extends: `@eslint/js` recommended, `typescript-eslint` recommended
|
|
317
|
+
- Plugins: `eslint-plugin-react-hooks` (flat recommended), `eslint-plugin-react-refresh` (vite config)
|
|
318
|
+
- Global ignores: `dist/`
|
|
319
|
+
- File pattern: `**/*.{ts,tsx}`
|
|
320
|
+
- ECMAScript version: 2020
|
|
321
|
+
- Globals: `browser`
|
|
322
|
+
|
|
323
|
+
### web/vercel.json
|
|
324
|
+
|
|
325
|
+
```json
|
|
326
|
+
{
|
|
327
|
+
"rewrites": [
|
|
328
|
+
{ "source": "/(.*)", "destination": "/index.html" }
|
|
329
|
+
]
|
|
330
|
+
}
|
|
331
|
+
```
|
|
332
|
+
|
|
333
|
+
SPA fallback — all routes rewrite to `index.html` for client-side routing.
|
|
334
|
+
|
|
335
|
+
---
|
|
336
|
+
|
|
337
|
+
## Platform-Specific Configuration
|
|
338
|
+
|
|
339
|
+
### Codex: config.toml
|
|
340
|
+
|
|
341
|
+
Located at `code-assistants/codex-assistant/config.toml`. TOML-format configuration specific to the OpenAI Codex CLI. Installed to `~/.codex/` during setup.
|
|
342
|
+
|
|
343
|
+
### Cursor: .cursorrules
|
|
344
|
+
|
|
345
|
+
Located at `code-assistants/cursor-assistant/.cursorrules`. Cursor's native rules format. During installation, this file is transformed and installed as `CURSOR.md` in `~/.cursor/`.
|
|
346
|
+
|
|
347
|
+
### Cursor: rules/ directory
|
|
348
|
+
|
|
349
|
+
Located at `code-assistants/cursor-assistant/rules/`. Contains MDC (Markdown Cursor) files installed to `~/.cursor/rules/` for Cursor's native rule system.
|
|
350
|
+
|
|
351
|
+
### Copilot: agent-assistant.agent.md
|
|
352
|
+
|
|
353
|
+
Located at `code-assistants/copilot-assistant/agent-assistant.agent.md`. Installed to the VS Code prompts folder:
|
|
354
|
+
- **macOS**: `~/Library/Application Support/Code/User/prompts/`
|
|
355
|
+
- **Windows**: `%APPDATA%/Code/User/prompts/`
|
|
356
|
+
- **Linux**: `~/.config/Code/User/prompts/`
|
|
357
|
+
|
|
358
|
+
---
|
|
359
|
+
|
|
360
|
+
## Environment Variables
|
|
361
|
+
|
|
362
|
+
### CLI Environment
|
|
363
|
+
|
|
364
|
+
The CLI (`cli/install.js`) uses no environment variables for core functionality. All paths are derived from:
|
|
365
|
+
- `os.homedir()` — User home directory
|
|
366
|
+
- `__dirname` — Script location (resolves to project root via `path.join(__dirname, '..')`)
|
|
367
|
+
- `process.platform` — OS detection for VS Code prompts path (`win32`, `darwin`, default)
|
|
368
|
+
|
|
369
|
+
One optional debug variable:
|
|
370
|
+
| Variable | Default | Purpose |
|
|
371
|
+
|----------|---------|---------|
|
|
372
|
+
| `DEBUG` | undefined | When set, enables verbose logging of symlink skips and copy errors |
|
|
373
|
+
|
|
374
|
+
### Web Application Environment
|
|
375
|
+
|
|
376
|
+
The `web/` directory has `.env` and `.env.*` excluded via `.gitignore`. No `.env.example` file exists in the repository. Vercel-specific environment variables may be configured in the Vercel dashboard but are not tracked in the repo.
|
|
377
|
+
|
|
378
|
+
### CI/CD Environment
|
|
379
|
+
|
|
380
|
+
semantic-release requires these environment variables (set in CI, not in repo):
|
|
381
|
+
| Variable | Purpose |
|
|
382
|
+
|----------|---------|
|
|
383
|
+
| `NPM_TOKEN` | npm registry authentication for publishing |
|
|
384
|
+
| `GITHUB_TOKEN` | GitHub API authentication for release creation |
|
|
385
|
+
| `GH_TOKEN` | Alternative to GITHUB_TOKEN (semantic-release convention) |
|
|
386
|
+
|
|
387
|
+
---
|
|
388
|
+
|
|
389
|
+
## Secrets Management
|
|
390
|
+
|
|
391
|
+
### Approach: No Secrets in Repository
|
|
392
|
+
|
|
393
|
+
The project follows a "no secrets" approach:
|
|
394
|
+
- `.gitignore` excludes `.env` and `.env.*` files
|
|
395
|
+
- CLI uses no API keys, tokens, or secrets at runtime
|
|
396
|
+
- All CI/CD secrets are managed via the CI platform's secret management (GitHub Actions environment variables)
|
|
397
|
+
- The only sensitive values are `NPM_TOKEN` and `GITHUB_TOKEN`/`GH_TOKEN` for the release pipeline
|
|
398
|
+
|
|
399
|
+
### Secret Locations
|
|
400
|
+
|
|
401
|
+
| Secret | Where It Lives | Used By |
|
|
402
|
+
|--------|---------------|---------|
|
|
403
|
+
| npm auth token | CI platform (GitHub Actions secrets) | `semantic-release` npm publish |
|
|
404
|
+
| GitHub token | CI platform (auto-provided `GITHUB_TOKEN` or manual `GH_TOKEN`) | `semantic-release` GitHub release + git push |
|
|
405
|
+
|
|
406
|
+
---
|
|
407
|
+
|
|
408
|
+
## Configuration Hierarchy
|
|
409
|
+
|
|
410
|
+
```
|
|
411
|
+
package.json ← Root package config
|
|
412
|
+
├── .releaserc.json ← Release pipeline (references package.json)
|
|
413
|
+
├── .gitignore ← Git exclusions
|
|
414
|
+
├── .husky/ ← Git hooks
|
|
415
|
+
│
|
|
416
|
+
├── matrix-skills/_index.yaml ← HSOL master config
|
|
417
|
+
│ ├── matrix-skills/_dynamic.yaml ← Dynamic skills manifest
|
|
418
|
+
│ └── matrix-skills/*.yaml ← 19 domain registries
|
|
419
|
+
│
|
|
420
|
+
├── rules/CORE.md ← Orchestrator protocol (uses {TOOL} from install)
|
|
421
|
+
│ ├── rules/PHASES.md
|
|
422
|
+
│ ├── rules/AGENTS.md
|
|
423
|
+
│ ├── rules/SKILLS.md
|
|
424
|
+
│ ├── rules/TEAMS.md
|
|
425
|
+
│ ├── rules/ERRORS.md
|
|
426
|
+
│ └── rules/REFERENCE.md
|
|
427
|
+
│
|
|
428
|
+
├── code-assistants/*/ ← Platform-specific configs
|
|
429
|
+
│ ├── cursor: .cursorrules, rules/
|
|
430
|
+
│ ├── copilot: agent-assistant.agent.md
|
|
431
|
+
│ ├── antigravity: GEMINI.md, AntigravityGlobal.agent.md
|
|
432
|
+
│ ├── claude: CLAUDE.md
|
|
433
|
+
│ └── codex: CODEX.md, config.toml, agents/, skills/
|
|
434
|
+
│
|
|
435
|
+
└── web/ ← Independent web config
|
|
436
|
+
├── package.json
|
|
437
|
+
├── vite.config.ts
|
|
438
|
+
├── tsconfig.json → tsconfig.app.json, tsconfig.node.json
|
|
439
|
+
├── eslint.config.js
|
|
440
|
+
└── vercel.json
|
|
441
|
+
```
|
|
442
|
+
|
|
443
|
+
---
|
|
444
|
+
|
|
445
|
+
## Evidence Sources
|
|
446
|
+
|
|
447
|
+
| File | Why it was used |
|
|
448
|
+
|------|-----------------|
|
|
449
|
+
| `package.json` | All root package fields: name, version, main, bin, engines, scripts, files, devDependencies, publishConfig |
|
|
450
|
+
| `.releaserc.json` | Full release pipeline configuration: branch, plugins, release rules, changelog sections |
|
|
451
|
+
| `.gitignore` | Complete exclusion patterns |
|
|
452
|
+
| `.husky/` listing | Git hooks directory structure |
|
|
453
|
+
| `cli/install.js` (lines 31–170) | TOOLS config: platform paths, replacements, assets; getVSCodePromptsFolder() for cross-platform VS Code paths |
|
|
454
|
+
| `cli/install.js` (lines 171–210) | CORE_DIRS, ROOT_FILES constants |
|
|
455
|
+
| `matrix-skills/_index.yaml` | HSOL v1.1 full configuration: enabled flag, version, find_skills, discovery settings |
|
|
456
|
+
| `web/package.json` | Web app package fields: name, private, version, type, scripts, dependencies, devDependencies |
|
|
457
|
+
| `web/vite.config.ts` | Vite plugins, build target, minifier, manual chunks |
|
|
458
|
+
| `web/tsconfig.json` | Project references |
|
|
459
|
+
| `web/tsconfig.app.json` | TypeScript compiler options: target, module, jsx, moduleResolution |
|
|
460
|
+
| `web/eslint.config.js` | ESLint v9 flat config: plugins, extends, file patterns, globals |
|
|
461
|
+
| `web/vercel.json` | SPA rewrite rules |
|
|
462
|
+
| `code-assistants/cursor-assistant/` listing | Cursor-specific assets |
|
|
463
|
+
| `code-assistants/copilot-assistant/` listing | Copilot-specific assets |
|
|
464
|
+
| `code-assistants/antigravity-assistant/` listing | Antigravity-specific assets |
|
|
465
|
+
| `code-assistants/claude-assistant/` listing | Claude-specific assets |
|
|
466
|
+
| `code-assistants/codex-assistant/` listing | Codex-specific assets with TOML and subdirectories |
|
|
467
|
+
| `rules/CORE.md` | Platform resolution table for {TOOL} placeholder mapping |
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
# Knowledge Standards
|
|
2
|
+
|
|
3
|
+
> **Purpose**: Standards summary, table of contents, quick reference of naming conventions, cross-references, and known gaps for the Agent Assistant project
|
|
4
|
+
> **Last Updated**: 2026-03-26
|
|
5
|
+
> **Generated By**: docs-core skill
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Quick Summary
|
|
10
|
+
|
|
11
|
+
Agent Assistant (`@namch/agent-assistant` v1.3.0) enforces a lean set of standards primarily through convention and tooling defaults rather than exhaustive configuration. The project uses Conventional Commits via semantic-release for versioning and publishing, Husky for git hooks, and Node.js built-in syntax checking for the CLI. The web sub-project adds ESLint 9 and TypeScript. There is no project-wide formatter (no Prettier), no CI/CD pipeline, no commitlint, no lint-staged, no editorconfig, and no test coverage tooling. Standards are largely implicit — derived from observed naming patterns, directory structure conventions, and YAML frontmatter schemas repeated consistently across hundreds of agent and command files.
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## Table of Contents
|
|
16
|
+
|
|
17
|
+
1. [Quick Summary](#quick-summary)
|
|
18
|
+
2. [Sub-Files](#sub-files)
|
|
19
|
+
3. [Quick Reference — Naming Conventions](#quick-reference--naming-conventions)
|
|
20
|
+
4. [Quick Facts](#quick-facts)
|
|
21
|
+
5. [Cross-References](#cross-references)
|
|
22
|
+
6. [Known Gaps](#known-gaps)
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## Sub-Files
|
|
27
|
+
|
|
28
|
+
| # | File | Description |
|
|
29
|
+
|---|------|-------------|
|
|
30
|
+
| 1 | [01-code-style.md](./01-code-style.md) | Formatting rules, naming conventions by content type (Markdown, YAML, JS, TSX), observed patterns |
|
|
31
|
+
| 2 | [02-conventions.md](./02-conventions.md) | File/directory organization, YAML frontmatter schemas, import patterns, module structure, document numbering |
|
|
32
|
+
| 3 | [03-git-workflow.md](./03-git-workflow.md) | Conventional Commits format, semantic-release pipeline, branch naming, Husky hooks, release process |
|
|
33
|
+
| 4 | [04-testing-standards.md](./04-testing-standards.md) | Test file organization, Node built-in test runner usage, coverage status, what exists vs what is missing |
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## Quick Reference — Naming Conventions
|
|
38
|
+
|
|
39
|
+
| Content Type | Pattern | Examples |
|
|
40
|
+
|-------------|---------|----------|
|
|
41
|
+
| Agent files | kebab-case `.md` | `backend-engineer.md`, `tech-lead.md` |
|
|
42
|
+
| Team directories | kebab-case dirs | `agents/teams/backend-team/` |
|
|
43
|
+
| Team role files | lowercase `.md` (fixed names) | `techlead.md`, `executor.md`, `reviewer.md` |
|
|
44
|
+
| Command files | kebab-case `.md` | `cook.md`, `brainstorm.md` |
|
|
45
|
+
| Command variants | kebab-case in subdirs | `commands/cook/fast.md`, `commands/cook/hard.md` |
|
|
46
|
+
| Rule files | UPPER_CASE `.md` | `CORE.md`, `PHASES.md`, `AGENTS.md` |
|
|
47
|
+
| Skill directories | kebab-case dirs | `skills/find-skills/`, `skills/ab-test-setup/` |
|
|
48
|
+
| Matrix skill files | kebab-case `.yaml` | `backend.yaml`, `ai-ml.yaml` |
|
|
49
|
+
| Special matrix files | underscore prefix `.yaml` | `_index.yaml`, `_dynamic.yaml` |
|
|
50
|
+
| Platform entries | UPPER_CASE `.md` | `CLAUDE.md`, `COPILOT.md`, `CURSOR.md` |
|
|
51
|
+
| Code assistant dirs | kebab-case dirs | `cursor-assistant/`, `copilot-assistant/` |
|
|
52
|
+
| Document directories | kebab-case dirs | `knowledge-overview/`, `knowledge-standards/` |
|
|
53
|
+
| Document files | numbered prefix + kebab-case | `00-index.md`, `01-project-identity.md` |
|
|
54
|
+
| Web components | PascalCase `.tsx` | `App.tsx` |
|
|
55
|
+
| Web entry points | camelCase `.tsx` | `main.tsx` |
|
|
56
|
+
| CLI source | camelCase `.js` | `install.js` |
|
|
57
|
+
| CLI test files | camelCase `.test.js` | `install.test.js.example` |
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## Quick Facts
|
|
62
|
+
|
|
63
|
+
| Standard | Status | Enforced By |
|
|
64
|
+
|----------|--------|-------------|
|
|
65
|
+
| Conventional Commits | Active | semantic-release commit-analyzer |
|
|
66
|
+
| Semantic Versioning | Active | semantic-release |
|
|
67
|
+
| Git Hooks | Active | Husky ^8.0.3 |
|
|
68
|
+
| JS Syntax Check | Active | `node --check` (lint script) |
|
|
69
|
+
| ESLint (web only) | Active | ESLint ^9.39.1 + typescript-eslint |
|
|
70
|
+
| TypeScript (web only) | Active | TypeScript compiler via tsconfig |
|
|
71
|
+
| Markdown Linting | Suggested, not enforced | `lint:md` script is echo-only |
|
|
72
|
+
| Prettier / Formatter | Not configured | — |
|
|
73
|
+
| CI/CD Pipeline | Not configured | — |
|
|
74
|
+
| commitlint | Not configured | — |
|
|
75
|
+
| lint-staged | Not configured | — |
|
|
76
|
+
| editorconfig | Not configured | — |
|
|
77
|
+
| Test Coverage | Not configured | — |
|
|
78
|
+
| Containerization | Not configured | — |
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## Cross-References
|
|
83
|
+
|
|
84
|
+
| Resource | Path | Relationship |
|
|
85
|
+
|----------|------|-------------|
|
|
86
|
+
| Knowledge Overview | [../knowledge-overview/00-index.md](../knowledge-overview/00-index.md) | Project summary and tech stack |
|
|
87
|
+
| Knowledge Architecture | [../knowledge-architecture/00-index.md](../knowledge-architecture/00-index.md) | System architecture and design |
|
|
88
|
+
| Knowledge Source Base | [../knowledge-source-base/00-index.md](../knowledge-source-base/00-index.md) | Directory structure and key modules |
|
|
89
|
+
| Knowledge Domain | [../knowledge-domain/00-index.md](../knowledge-domain/00-index.md) | Domain model and business logic |
|
|
90
|
+
| Package Manifest | [../../package.json](../../package.json) | Scripts, dependencies, engine requirements |
|
|
91
|
+
| Release Config | [../../.releaserc.json](../../.releaserc.json) | semantic-release plugin chain and rules |
|
|
92
|
+
| Git Ignore | [../../.gitignore](../../.gitignore) | Excluded paths and patterns |
|
|
93
|
+
| Core Rules | [../../rules/CORE.md](../../rules/CORE.md) | Orchestrator protocol and governance laws |
|
|
94
|
+
| Web ESLint Config | [../../web/eslint.config.js](../../web/eslint.config.js) | ESLint 9 flat config for web sub-project |
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
## Known Gaps
|
|
99
|
+
|
|
100
|
+
These are documented absences — not recommendations. They reflect the current state of the project as of v1.3.0.
|
|
101
|
+
|
|
102
|
+
| Gap | Impact | Notes |
|
|
103
|
+
|-----|--------|-------|
|
|
104
|
+
| No CI/CD pipeline | Releases depend on local `npx semantic-release` execution; no automated PR checks | No `.github/workflows/` directory exists |
|
|
105
|
+
| No Prettier or formatter | Code style consistency relies entirely on developer discipline | No `.prettierrc`, no formatting script |
|
|
106
|
+
| No commitlint | Commit message format is only validated at release time by semantic-release, not at commit time | semantic-release will skip unrecognized types silently |
|
|
107
|
+
| No lint-staged | No pre-commit hook runs linters on staged files | Husky is installed but no lint-staged integration |
|
|
108
|
+
| No editorconfig | No cross-editor formatting defaults (indent size, charset, line endings) | No `.editorconfig` file |
|
|
109
|
+
| No test coverage tool | No way to measure or enforce code coverage thresholds | No nyc, c8, or istanbul configured |
|
|
110
|
+
| No integration/e2e tests | Only unit-level test examples exist; no end-to-end testing of the install flow | Test file is an example (`.example` extension) |
|
|
111
|
+
| No Dockerfile | No containerization support | Not applicable for current use case (CLI tool + static site) |
|
|
112
|
+
| Markdown linting is advisory | `lint:md` script only echoes a suggestion; does not actually run markdownlint | Would need `npx markdownlint` to be wired in |
|
|
113
|
+
|
|
114
|
+
---
|
|
115
|
+
|
|
116
|
+
## Evidence Sources
|
|
117
|
+
|
|
118
|
+
| Source | Path |
|
|
119
|
+
|--------|------|
|
|
120
|
+
| Package manifest | [../../package.json](../../package.json) |
|
|
121
|
+
| Release configuration | [../../.releaserc.json](../../.releaserc.json) |
|
|
122
|
+
| Git ignore patterns | [../../.gitignore](../../.gitignore) |
|
|
123
|
+
| Husky directory | `../../.husky/` |
|
|
124
|
+
| Web ESLint config | [../../web/eslint.config.js](../../web/eslint.config.js) |
|
|
125
|
+
| Agent file examples | [../../agents/backend-engineer.md](../../agents/backend-engineer.md) |
|
|
126
|
+
| Command file examples | [../../commands/cook.md](../../commands/cook.md) |
|
|
127
|
+
| CLI source | [../../cli/install.js](../../cli/install.js) |
|
|
128
|
+
| Example test file | [../../cli/install.test.js.example](../../cli/install.test.js.example) |
|
|
129
|
+
| Rule files | `../../rules/CORE.md`, `../../rules/PHASES.md` |
|