@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.
Files changed (90) hide show
  1. package/CHANGELOG.md +11 -1
  2. package/agents/backend-engineer.md +3 -3
  3. package/agents/brainstormer.md +3 -3
  4. package/agents/business-analyst.md +3 -3
  5. package/agents/database-architect.md +3 -3
  6. package/agents/debugger.md +2 -2
  7. package/agents/designer.md +2 -2
  8. package/agents/devops-engineer.md +2 -2
  9. package/agents/docs-manager.md +23 -15
  10. package/agents/frontend-engineer.md +3 -3
  11. package/agents/game-engineer.md +3 -3
  12. package/agents/mobile-engineer.md +4 -4
  13. package/agents/performance-engineer.md +3 -3
  14. package/agents/planner.md +4 -4
  15. package/agents/project-manager.md +3 -3
  16. package/agents/researcher.md +3 -3
  17. package/agents/reviewer.md +3 -3
  18. package/agents/scouter.md +3 -3
  19. package/agents/security-engineer.md +3 -3
  20. package/agents/tech-lead.md +3 -3
  21. package/agents/tester.md +2 -2
  22. package/commands/docs/audit.md +554 -78
  23. package/commands/docs/business.md +392 -76
  24. package/commands/docs/core.md +573 -74
  25. package/commands/docs.md +62 -61
  26. package/documents/business/business-features/00-index.md +101 -0
  27. package/documents/business/business-features/01-feature-inventory.md +341 -0
  28. package/documents/business/business-features/02-prioritization-moscow.md +148 -0
  29. package/documents/business/business-features/03-feature-specifications.md +512 -0
  30. package/documents/business/business-features/04-dependencies-and-release-sequencing.md +313 -0
  31. package/documents/business/business-features/05-success-metrics.md +290 -0
  32. package/documents/business/business-glossary/00-index.md +89 -0
  33. package/documents/business/business-glossary/01-canonical-terms.md +428 -0
  34. package/documents/business/business-glossary/02-synonyms-and-deprecated-terms.md +180 -0
  35. package/documents/business/business-glossary/03-domain-entities-and-events.md +395 -0
  36. package/documents/business/business-glossary/04-api-term-mapping.md +173 -0
  37. package/documents/business/business-prd/00-index.md +107 -0
  38. package/documents/business/business-prd/01-executive-summary.md +131 -0
  39. package/documents/business/business-prd/02-problem-goals-and-scope.md +204 -0
  40. package/documents/business/business-prd/03-stakeholders-and-requirements.md +210 -0
  41. package/documents/business/business-prd/04-acceptance-risks-assumptions.md +246 -0
  42. package/documents/business/business-workflows/00-index.md +107 -0
  43. package/documents/business/business-workflows/01-actor-map.md +303 -0
  44. package/documents/business/business-workflows/02-workflow-catalog.md +252 -0
  45. package/documents/business/business-workflows/03-detailed-workflows.md +641 -0
  46. package/documents/business/business-workflows/04-decision-rules-and-exceptions.md +216 -0
  47. package/documents/business/business-workflows/05-sla-and-handoffs.md +253 -0
  48. package/documents/knowledge-architecture/00-index.md +159 -0
  49. package/documents/knowledge-architecture/01-system-overview.md +240 -0
  50. package/documents/knowledge-architecture/02-components.md +419 -0
  51. package/documents/knowledge-architecture/03-data-flow.md +369 -0
  52. package/documents/knowledge-architecture/04-design-patterns.md +498 -0
  53. package/documents/knowledge-architecture/05-decisions.md +410 -0
  54. package/documents/knowledge-domain/00-index.md +251 -0
  55. package/documents/knowledge-domain/01-entities.md +583 -0
  56. package/documents/knowledge-domain/02-database-schema.md +138 -0
  57. package/documents/knowledge-domain/03-api-contracts.md +479 -0
  58. package/documents/knowledge-domain/04-business-rules.md +555 -0
  59. package/documents/knowledge-overview/00-index.md +107 -0
  60. package/documents/knowledge-overview/01-project-identity.md +162 -0
  61. package/documents/knowledge-overview/02-tech-stack.md +119 -0
  62. package/documents/knowledge-overview/03-features.md +233 -0
  63. package/documents/knowledge-overview/04-getting-started.md +394 -0
  64. package/documents/knowledge-source-base/00-index.md +107 -0
  65. package/documents/knowledge-source-base/01-directory-structure.md +312 -0
  66. package/documents/knowledge-source-base/02-entry-points.md +346 -0
  67. package/documents/knowledge-source-base/03-key-modules.md +582 -0
  68. package/documents/knowledge-source-base/04-configuration.md +467 -0
  69. package/documents/knowledge-standards/00-index.md +129 -0
  70. package/documents/knowledge-standards/01-code-style.md +161 -0
  71. package/documents/knowledge-standards/02-conventions.md +255 -0
  72. package/documents/knowledge-standards/03-git-workflow.md +228 -0
  73. package/documents/knowledge-standards/04-testing-standards.md +175 -0
  74. package/package.json +1 -1
  75. package/rules/REFERENCE.md +10 -6
  76. package/skills/docs-audit/README.md +10 -8
  77. package/skills/docs-audit/SKILL.md +45 -41
  78. package/skills/docs-audit/references/scoring-framework.md +5 -5
  79. package/skills/docs-core/README.md +19 -14
  80. package/skills/docs-core/SKILL.md +189 -117
  81. package/skills/planning/references/codebase-understanding.md +5 -5
  82. package/documents/business/business-features.md +0 -894
  83. package/documents/business/business-glossary.md +0 -554
  84. package/documents/business/business-prd.md +0 -400
  85. package/documents/business/business-workflows.md +0 -713
  86. package/documents/knowledge-architecture.md +0 -621
  87. package/documents/knowledge-domain.md +0 -602
  88. package/documents/knowledge-overview.md +0 -316
  89. package/documents/knowledge-source-base.md +0 -581
  90. package/documents/knowledge-standards.md +0 -632
@@ -0,0 +1,312 @@
1
+ # Agent Assistant — Directory Structure
2
+
3
+ > **Purpose**: Complete annotated directory tree (depth 3-4) with functional purpose of every top-level directory and key files
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
+ 1. [Root Directory Overview](#root-directory-overview)
13
+ 2. [Annotated Directory Tree](#annotated-directory-tree)
14
+ 3. [Top-Level Directory Purposes](#top-level-directory-purposes)
15
+ 4. [Root File Purposes](#root-file-purposes)
16
+ 5. [File Count Summary](#file-count-summary)
17
+ 6. [Evidence Sources](#evidence-sources)
18
+
19
+ ---
20
+
21
+ ## Root Directory Overview
22
+
23
+ The project root contains 10 top-level directories and 12 root-level files. The framework is organized into a clear separation: **framework content** (agents, commands, rules, skills, matrix-skills) that gets installed into AI tool directories, **CLI tooling** (cli/) that performs the installation, **platform templates** (code-assistants/) with per-tool customizations, **documentation** (documents/), and a **marketing website** (web/) that is an independent sub-project.
24
+
25
+ ---
26
+
27
+ ## Annotated Directory Tree
28
+
29
+ ```
30
+ agent-assistant/ # Project root — npm package @namch/agent-assistant
31
+
32
+ ├── package.json # npm manifest: scripts, deps, engines, bin, files
33
+ ├── package-lock.json # Locked dependency tree
34
+ ├── .releaserc.json # semantic-release config (conventional commits, main branch)
35
+ ├── .gitignore # Excludes node_modules, dist, .env, reports/
36
+ ├── LICENSE # MIT license
37
+ ├── README.md # Project README (published to npm)
38
+ ├── CHANGELOG.md # Auto-generated version history (semantic-release)
39
+
40
+ ├── AGENT.md # Generic agent entry point (platform-agnostic)
41
+ ├── AGENT-TEMPLATE.md # Template spec for creating new agent files (Matrix Skill Discovery)
42
+ ├── CLAUDE.md # Claude Code platform entry point
43
+ ├── CODEX.md # Codex platform entry point
44
+ ├── COPILOT.md # GitHub Copilot platform entry point
45
+ ├── CURSOR.md # Cursor platform entry point
46
+ ├── GEMINI.md # Gemini/Antigravity platform entry point
47
+
48
+ ├── .husky/ # Git hooks manager
49
+ │ └── _/ # Husky internal runtime files
50
+
51
+ ├── agents/ # 21 specialist agent definitions + 17 teams
52
+ │ ├── backend-engineer.md # Backend implementation specialist
53
+ │ ├── brainstormer.md # Creative ideation agent
54
+ │ ├── business-analyst.md # Business requirements analysis
55
+ │ ├── database-architect.md # Database design specialist
56
+ │ ├── debugger.md # Bug diagnosis and resolution
57
+ │ ├── designer.md # UI/UX design specialist
58
+ │ ├── devops-engineer.md # CI/CD and infrastructure
59
+ │ ├── docs-manager.md # Documentation architecture
60
+ │ ├── frontend-engineer.md # Frontend implementation specialist
61
+ │ ├── game-engineer.md # Game development specialist
62
+ │ ├── mobile-engineer.md # Mobile app development
63
+ │ ├── performance-engineer.md # Performance optimization
64
+ │ ├── planner.md # Project and task planning
65
+ │ ├── project-manager.md # Project coordination
66
+ │ ├── reporter.md # Intelligence and analysis reporting
67
+ │ ├── researcher.md # Research and exploration
68
+ │ ├── reviewer.md # Code and design reviews
69
+ │ ├── scouter.md # Codebase reconnaissance
70
+ │ ├── security-engineer.md # Security analysis and hardening
71
+ │ ├── tech-lead.md # Architecture decisions and oversight
72
+ │ ├── tester.md # Test strategy and implementation
73
+ │ └── teams/ # 17 team directories × 3 roles each = 51 team agents
74
+ │ ├── backend-team/ # executor.md, reviewer.md, techlead.md
75
+ │ ├── database-team/ # executor.md, reviewer.md, techlead.md
76
+ │ ├── debug-team/ # executor.md, reviewer.md, techlead.md
77
+ │ ├── design-team/ # executor.md, reviewer.md, techlead.md
78
+ │ ├── devops-team/ # executor.md, reviewer.md, techlead.md
79
+ │ ├── docs-team/ # executor.md, reviewer.md, techlead.md
80
+ │ ├── frontend-team/ # executor.md, reviewer.md, techlead.md
81
+ │ ├── fullstack-team/ # executor.md, reviewer.md, techlead.md
82
+ │ ├── game-team/ # executor.md, reviewer.md, techlead.md
83
+ │ ├── mobile-team/ # executor.md, reviewer.md, techlead.md
84
+ │ ├── performance-team/ # executor.md, reviewer.md, techlead.md
85
+ │ ├── planning-team/ # executor.md, reviewer.md, techlead.md
86
+ │ ├── project-team/ # executor.md, reviewer.md, techlead.md
87
+ │ ├── qa-team/ # executor.md, reviewer.md, techlead.md
88
+ │ ├── report-team/ # executor.md, reviewer.md, techlead.md
89
+ │ ├── research-team/ # executor.md, reviewer.md, techlead.md
90
+ │ └── security-team/ # executor.md, reviewer.md, techlead.md
91
+
92
+ ├── cli/ # CLI tooling — the only executable code
93
+ │ ├── install.js # Main CLI entry (~600 lines, CommonJS, shebang)
94
+ │ ├── install.test.js.example # Example test file (not active)
95
+ │ └── README.md # CLI usage documentation
96
+
97
+ ├── code-assistants/ # Platform-specific installation templates
98
+ │ ├── antigravity-assistant/ # Gemini/Antigravity platform assets
99
+ │ │ ├── GEMINI.md # Antigravity-specific entry point
100
+ │ │ └── AntigravityGlobal.agent.md # Global agent config for Antigravity
101
+ │ ├── claude-assistant/ # Claude Code platform assets
102
+ │ │ └── CLAUDE.md # Claude-specific entry point
103
+ │ ├── codex-assistant/ # Codex platform assets
104
+ │ │ ├── CODEX.md # Codex-specific entry point
105
+ │ │ ├── config.toml # Codex TOML configuration
106
+ │ │ ├── agents/ # Codex-specific agent TOML files
107
+ │ │ └── skills/ # Codex-specific skill overrides
108
+ │ ├── copilot-assistant/ # GitHub Copilot platform assets
109
+ │ │ └── agent-assistant.agent.md # Copilot agent definition file
110
+ │ └── cursor-assistant/ # Cursor platform assets
111
+ │ ├── .cursorrules # Cursor rules file (becomes CURSOR.md on install)
112
+ │ └── rules/ # Cursor MDC rule files
113
+
114
+ ├── commands/ # 14 command routers + variant subdirectories
115
+ │ ├── ask.md # /ask command router
116
+ │ ├── ask/ # fast.md, hard.md (2 variants)
117
+ │ ├── auto.md # /auto command router (no variants)
118
+ │ ├── brainstorm.md # /brainstorm command router
119
+ │ ├── brainstorm/ # fast.md, hard.md, team.md (3 variants)
120
+ │ ├── code.md # /code command router
121
+ │ ├── code/ # fast.md, focus.md, hard.md, team.md (4 variants)
122
+ │ ├── cook.md # /cook command router
123
+ │ ├── cook/ # fast.md, focus.md, hard.md, team.md (4 variants)
124
+ │ ├── debug.md # /debug command router
125
+ │ ├── debug/ # fast.md, focus.md, hard.md, team.md (4 variants)
126
+ │ ├── deploy.md # /deploy command router
127
+ │ ├── deploy/ # check.md, preview.md, production.md, rollback.md (4 variants)
128
+ │ ├── design.md # /design command router
129
+ │ ├── design/ # fast.md, focus.md, hard.md, team.md (4 variants)
130
+ │ ├── docs.md # /docs command router
131
+ │ ├── docs/ # audit.md, business.md, core.md (3 variants)
132
+ │ ├── fix.md # /fix command router
133
+ │ ├── fix/ # fast.md, focus.md, hard.md, team.md (4 variants)
134
+ │ ├── plan.md # /plan command router
135
+ │ ├── plan/ # fast.md, focus.md, hard.md, team.md (4 variants)
136
+ │ ├── report.md # /report command router
137
+ │ ├── report/ # fast.md, focus.md, hard.md, team.md (4 variants)
138
+ │ ├── review.md # /review command router
139
+ │ ├── review/ # fast.md, hard.md, team.md (3 variants)
140
+ │ ├── test.md # /test command router
141
+ │ └── test/ # fast.md, focus.md, hard.md, team.md (4 variants)
142
+
143
+ ├── documents/ # Project documentation
144
+ │ ├── HSOL-ASSESSMENT.md # Assessment of HSOL system
145
+ │ ├── SMART-SKILL-ORCHESTRATION-BLUEPRINT.md # HSOL design blueprint
146
+ │ └── knowledge-source-base/ # Technical knowledge base (this folder)
147
+
148
+ ├── matrix-skills/ # HSOL domain skill registries (YAML)
149
+ │ ├── _index.yaml # Central HSOL registry — config, discovery settings, domain listing
150
+ │ ├── _dynamic.yaml # Community/dynamic skill manifest
151
+ │ ├── ai-ml.yaml # AI/ML domain skills
152
+ │ ├── architecture.yaml # Architecture domain skills
153
+ │ ├── backend.yaml # Backend domain skills
154
+ │ ├── cloud.yaml # Cloud infrastructure skills
155
+ │ ├── data.yaml # Data engineering skills
156
+ │ ├── design.yaml # Design domain skills
157
+ │ ├── devops.yaml # DevOps domain skills
158
+ │ ├── frontend.yaml # Frontend domain skills
159
+ │ ├── gaming.yaml # Game development skills
160
+ │ ├── languages.yaml # Programming language skills
161
+ │ ├── management.yaml # Management domain skills
162
+ │ ├── mcp.yaml # Model Context Protocol skills
163
+ │ ├── mobile.yaml # Mobile development skills
164
+ │ ├── performance.yaml # Performance domain skills
165
+ │ ├── planning.yaml # Planning domain skills
166
+ │ ├── quality.yaml # Quality/testing domain skills
167
+ │ ├── research.yaml # Research domain skills
168
+ │ ├── security.yaml # Security domain skills
169
+ │ └── tools.yaml # Developer tooling skills
170
+
171
+ ├── rules/ # Orchestration protocol rules (7 files)
172
+ │ ├── CORE.md # v4.1 — Orchestrator identity, paths, 10 Laws (always loaded first)
173
+ │ ├── PHASES.md # Phase execution order and output format
174
+ │ ├── AGENTS.md # Tiered execution: sub-agent (Tier 1) vs embodiment (Tier 2)
175
+ │ ├── SKILLS.md # HSOL skill resolution protocol
176
+ │ ├── TEAMS.md # Multi-agent team coordination protocol
177
+ │ ├── ERRORS.md # Error recovery procedures
178
+ │ └── REFERENCE.md # Quick lookup tables
179
+
180
+ ├── skills/ # 1,430 skill folders (each with SKILL.md)
181
+ │ ├── 00-andruia-consultant/ # Example: Andruia consultant skill
182
+ │ ├── 007/ # Example: 007 skill
183
+ │ ├── find-skills/ # Special: dynamic skill discovery skill
184
+ │ ├── ... # (1,427 more skill folders)
185
+ │ └── {skill-name}/ # Each contains at minimum a SKILL.md file
186
+ │ └── SKILL.md # Skill definition, instructions, and metadata
187
+
188
+ ├── web/ # Marketing website (independent sub-project)
189
+ │ ├── package.json # React 19, Vite, Tailwind CSS 4, framer-motion
190
+ │ ├── package-lock.json # Web dependency lock
191
+ │ ├── vite.config.ts # Vite config with React + Tailwind plugins
192
+ │ ├── tsconfig.json # Root TS config (references app + node configs)
193
+ │ ├── tsconfig.app.json # App TS config — ES2022, bundler module resolution
194
+ │ ├── tsconfig.node.json # Node TS config for build tooling
195
+ │ ├── eslint.config.js # ESLint v9 flat config with TS + React plugins
196
+ │ ├── vercel.json # Vercel deployment: SPA rewrites
197
+ │ ├── index.html # Vite HTML entry point
198
+ │ ├── .gitignore # Web-specific ignores
199
+ │ ├── .npmrc # npm registry config
200
+ │ ├── public/ # Static assets
201
+ │ ├── src/ # React source code
202
+ │ │ ├── main.tsx # React app mount point
203
+ │ │ ├── App.tsx # Root component with routing
204
+ │ │ ├── components/ # Reusable UI components
205
+ │ │ ├── pages/ # Page-level route components
206
+ │ │ ├── hooks/ # Custom React hooks
207
+ │ │ ├── lib/ # Utility libraries
208
+ │ │ ├── data/ # Static data/content
209
+ │ │ ├── styles/ # Global styles (Tailwind)
210
+ │ │ └── types/ # TypeScript type definitions
211
+ │ ├── dist/ # Build output (gitignored in web/.gitignore)
212
+ │ └── reports/ # Web-specific reports
213
+
214
+ └── node_modules/ # Installed dependencies (gitignored)
215
+ ```
216
+
217
+ ---
218
+
219
+ ## Top-Level Directory Purposes
220
+
221
+ ### `agents/` — Specialist Agent Definitions
222
+ Contains 21 solo agent Markdown files and a `teams/` subdirectory with 17 team directories. Each solo agent file defines a specialist role (backend-engineer, debugger, tester, etc.) with YAML frontmatter for Matrix Skill Discovery and structured sections for identity, capabilities, and workflow. Team directories each contain three standardized roles: `executor.md`, `reviewer.md`, and `techlead.md`. Total: 72 agent files.
223
+
224
+ ### `cli/` — Command-Line Interface
225
+ The only directory containing executable code. Houses `install.js` (~600 lines, CommonJS, shebang `#!/usr/bin/env node`) that handles install/uninstall/list operations for all 5 supported platforms. Uses exclusively Node.js built-in modules (fs, path, os, readline). Also contains an example test file and a CLI-specific README.
226
+
227
+ ### `code-assistants/` — Platform Installation Templates
228
+ Contains 5 subdirectories, one per supported AI coding tool. Each provides platform-specific assets (entry point files, config files, rule files) that are copied during installation. The CLI reads from these directories to customize the installation for each platform's directory structure and file conventions.
229
+
230
+ ### `commands/` — Command Workflows
231
+ Contains 14 command router files (`.md`) at the top level and corresponding subdirectories with variant strategies. Standard variants are `fast.md`, `focus.md`, `hard.md`, `team.md`; deploy uses `check.md`, `preview.md`, `production.md`, `rollback.md`; docs uses `audit.md`, `business.md`, `core.md`. The command router file defines the base workflow, and variants modify execution strategy. Total: 61 Markdown files.
232
+
233
+ ### `documents/` — Project Documentation
234
+ Stores long-form project documentation including the HSOL design blueprint, HSOL assessment, and the knowledge source base (this folder). Files here are included in the npm package and copied during installation to `~/.{tool}/skills/agent-assistant/documents/`.
235
+
236
+ ### `matrix-skills/` — HSOL Domain Registries
237
+ Contains 21 YAML files: `_index.yaml` (central registry with HSOL configuration and discovery settings), `_dynamic.yaml` (community-installed dynamic skills), and 19 domain-specific registries. Each domain YAML maps skills to agents by profile, priority, and relevance. The HSOL version is 1.1 with 1,430 total matrix skills.
238
+
239
+ ### `rules/` — Orchestration Protocol
240
+ Seven Markdown files that define the Orchestrator's "operating system." `CORE.md` (v4.1) is always loaded first and establishes the Orchestrator's identity, path conventions, and the 10 Laws. Other files are loaded on-demand: PHASES (execution order), AGENTS (tiered execution), SKILLS (HSOL resolution), TEAMS (multi-agent coordination), ERRORS (recovery), REFERENCE (lookup tables).
241
+
242
+ ### `skills/` — Skill Library
243
+ Contains 1,430 skill folders, each with at minimum a `SKILL.md` file. Skills are the atomic units of capability in the HSOL system — each defines instructions, context, and metadata for a specific technique or domain. The special `find-skills/` skill handles dynamic skill discovery from the external skills.sh registry.
244
+
245
+ ### `web/` — Marketing Website
246
+ An independent React 19 + Vite + Tailwind CSS 4 sub-project with its own `package.json`, TypeScript configuration, and ESLint setup. Deployed to Vercel with SPA rewrite rules. Uses framer-motion for animations, react-router-dom for routing, lucide-react for icons, and @xyflow/react for flow diagrams. Has a standard `src/` layout with components, pages, hooks, lib, data, styles, and types directories.
247
+
248
+ ### `.husky/` — Git Hooks
249
+ Husky v8 git hooks manager directory. Contains the internal `_/` runtime directory. Used with the `prepare` script (`husky install || true`) to set up commit hooks for the development workflow.
250
+
251
+ ---
252
+
253
+ ## Root File Purposes
254
+
255
+ | File | Purpose |
256
+ |------|---------|
257
+ | `package.json` | npm package manifest — defines name, version, scripts, bin, engines, files, devDependencies |
258
+ | `package-lock.json` | Locked dependency tree for reproducible installs |
259
+ | `.releaserc.json` | semantic-release configuration — conventional commits preset, main branch, changelog + npm + git + github plugins |
260
+ | `.gitignore` | Git exclusion rules — node_modules, dist, .env, reports/, coverage/, logs |
261
+ | `LICENSE` | MIT license |
262
+ | `README.md` | Project README — published with npm package, copied during installation |
263
+ | `CHANGELOG.md` | Auto-generated by semantic-release — version history with conventional commit sections |
264
+ | `AGENT.md` | Platform-agnostic Orchestrator entry point |
265
+ | `AGENT-TEMPLATE.md` | Specification template for creating new agent files with Matrix Skill Discovery frontmatter |
266
+ | `CLAUDE.md` | Claude Code platform entry point — bootstraps Orchestrator for Claude |
267
+ | `CODEX.md` | Codex platform entry point — bootstraps Orchestrator for Codex |
268
+ | `COPILOT.md` | GitHub Copilot platform entry point — bootstraps Orchestrator for Copilot |
269
+ | `CURSOR.md` | Cursor platform entry point — bootstraps Orchestrator for Cursor |
270
+ | `GEMINI.md` | Gemini/Antigravity platform entry point — bootstraps Orchestrator for Gemini |
271
+
272
+ ---
273
+
274
+ ## File Count Summary
275
+
276
+ | Directory | Files (approx.) | Format |
277
+ |-----------|-----------------|--------|
278
+ | `agents/` (solo) | 21 | Markdown |
279
+ | `agents/teams/` | 51 (17 × 3) | Markdown |
280
+ | `cli/` | 3 | JavaScript, Markdown |
281
+ | `code-assistants/` | ~10 | Markdown, TOML, rules |
282
+ | `commands/` | 61 (14 routers + 47 variants) | Markdown |
283
+ | `documents/` | 2 + knowledge-source-base | Markdown |
284
+ | `matrix-skills/` | 21 | YAML |
285
+ | `rules/` | 7 | Markdown |
286
+ | `skills/` | 1,430+ | Markdown (SKILL.md each) |
287
+ | `web/src/` | ~30+ | TypeScript, TSX, CSS |
288
+ | Root files | 14 | Markdown, JSON |
289
+
290
+ ---
291
+
292
+ ## Evidence Sources
293
+
294
+ | File | Why it was used |
295
+ |------|-----------------|
296
+ | `package.json` | Verified project name, version, scripts, bin, files, engines, devDependencies |
297
+ | `cli/install.js` | Confirmed TOOLS config with 5 platforms, CORE_DIRS, BUNDLED_AGENTS list, ROOT_FILES |
298
+ | `.releaserc.json` | Verified semantic-release plugin chain and branch config |
299
+ | `.gitignore` | Confirmed exclusion rules for node_modules, dist, .env, reports |
300
+ | `AGENT-TEMPLATE.md` | Verified agent file structure with Matrix Skill Discovery frontmatter |
301
+ | `matrix-skills/_index.yaml` | Confirmed HSOL v1.1, 1,430 matrix skills, discovery config |
302
+ | `rules/CORE.md` | Confirmed CORE v4.1, Orchestrator identity, path conventions |
303
+ | `web/package.json` | Verified React 19 dependencies, Vite scripts |
304
+ | `web/vite.config.ts` | Confirmed React + Tailwind plugins, chunk splitting |
305
+ | `web/vercel.json` | Confirmed SPA rewrite rules for Vercel deployment |
306
+ | `web/tsconfig.json` | Confirmed TS project references (app + node) |
307
+ | `web/tsconfig.app.json` | Confirmed ES2022 target, bundler module resolution |
308
+ | `web/eslint.config.js` | Confirmed ESLint v9 flat config with TS + React plugins |
309
+ | `agents/` directory listing | Counted 21 solo agent files |
310
+ | `agents/teams/` directory listing | Counted 17 team directories, each with 3 role files |
311
+ | `commands/` directory listing | Counted 14 router files and all variant subdirectories |
312
+ | `code-assistants/` directory listing | Confirmed 5 platform template directories and their contents |
@@ -0,0 +1,346 @@
1
+ # Agent Assistant — Entry Points
2
+
3
+ > **Purpose**: Maps all application entry files, the CLI boot sequence, build/script entry points, and configuration entry points
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
+ 1. [Application Entry Files](#application-entry-files)
13
+ 2. [CLI Boot Sequence](#cli-boot-sequence)
14
+ 3. [Platform Entry Points](#platform-entry-points)
15
+ 4. [Build and Script Entry Points](#build-and-script-entry-points)
16
+ 5. [Config Entry Points](#config-entry-points)
17
+ 6. [Web Application Entry Points](#web-application-entry-points)
18
+ 7. [Evidence Sources](#evidence-sources)
19
+
20
+ ---
21
+
22
+ ## Application Entry Files
23
+
24
+ ### Primary: `cli/install.js`
25
+
26
+ This is the **sole executable file** in the entire project. It is declared in `package.json` under both `main` and `bin`:
27
+
28
+ ```json
29
+ {
30
+ "main": "cli/install.js",
31
+ "bin": {
32
+ "agent-assistant": "./cli/install.js"
33
+ }
34
+ }
35
+ ```
36
+
37
+ - **Shebang**: `#!/usr/bin/env node`
38
+ - **Module System**: CommonJS (`require()`)
39
+ - **Dependencies**: Node.js built-ins only — `node:fs`, `node:path`, `node:os`, `node:readline`
40
+ - **Size**: ~600 lines
41
+ - **Minimum Runtime**: Node.js >=18.0.0
42
+
43
+ When installed globally via `npm install -g @namch/agent-assistant`, the `agent-assistant` binary becomes available system-wide. When invoked via `npx`, it runs directly from the package.
44
+
45
+ ### Secondary: Platform Entry Point Files (Root)
46
+
47
+ These 6 Markdown files serve as the "boot" files that AI coding assistants read to initialize the Orchestrator:
48
+
49
+ | File | Platform | Role |
50
+ |------|----------|------|
51
+ | `AGENT.md` | All platforms | Generic/platform-agnostic Orchestrator entry |
52
+ | `CURSOR.md` | Cursor | Cursor-specific Orchestrator bootstrap |
53
+ | `COPILOT.md` | GitHub Copilot | Copilot-specific Orchestrator bootstrap |
54
+ | `CLAUDE.md` | Claude Code | Claude-specific Orchestrator bootstrap |
55
+ | `CODEX.md` | Codex | Codex-specific Orchestrator bootstrap |
56
+ | `GEMINI.md` | Antigravity/Gemini | Gemini-specific Orchestrator bootstrap |
57
+
58
+ These files are **not executed** — they are read by AI coding assistants as instruction/configuration files. Each directs the AI to load `rules/CORE.md` and activate the Orchestrator role.
59
+
60
+ ---
61
+
62
+ ## CLI Boot Sequence
63
+
64
+ When the user runs any CLI command, execution follows this sequence:
65
+
66
+ ### 1. Invocation
67
+
68
+ ```bash
69
+ # Direct invocation
70
+ node cli/install.js <command> [tool] [flags]
71
+
72
+ # Via npm scripts
73
+ npm run install:cursor # → node cli/install.js install cursor
74
+ npm run install:all # → node cli/install.js install --all
75
+ npm run uninstall:copilot # → node cli/install.js uninstall copilot
76
+ npm run list # → node cli/install.js list
77
+
78
+ # Via npx (after npm publish)
79
+ npx agent-assistant install cursor
80
+ npx @namch/agent-assistant install --all
81
+ ```
82
+
83
+ ### 2. Module Loading
84
+
85
+ ```
86
+ cli/install.js loads:
87
+ ├── node:fs — File system operations (read, write, copy, remove, exists, sync)
88
+ ├── node:path — Path resolution and manipulation
89
+ ├── node:os — Home directory detection via os.homedir()
90
+ └── node:readline — Interactive terminal prompts (confirmation dialogs)
91
+ ```
92
+
93
+ ### 3. Configuration Resolution
94
+
95
+ ```
96
+ HOME = os.homedir() # e.g., /Users/username
97
+ ROOT = path.join(__dirname, '..') # Project root (relative to cli/)
98
+
99
+ TOOLS = {
100
+ cursor: { paths, replacements, assets }
101
+ copilot: { paths, replacements, assets }
102
+ antigravity: { paths, replacements, assets }
103
+ claude: { paths, replacements, assets }
104
+ codex: { paths, replacements, assets }
105
+ }
106
+
107
+ CORE_DIRS = ['agents', 'rules', 'documents', 'commands', 'matrix-skills']
108
+ ROOT_FILES = ['README.md']
109
+ ```
110
+
111
+ ### 4. Argument Parsing
112
+
113
+ The CLI parses `process.argv` to determine:
114
+ - **Command**: `install`, `uninstall`, or `list`
115
+ - **Tool**: one of `cursor`, `copilot`, `antigravity`, `claude`, `codex`
116
+ - **Flags**: `--all` (operate on all platforms), `--force` (skip confirmation)
117
+
118
+ ### 5. Command Execution
119
+
120
+ #### Install Flow
121
+ ```
122
+ resetProgress()
123
+ → estimateInstallFiles() # Counts files across CORE_DIRS + skills + agents
124
+ → Per-platform install function:
125
+ 1. Copy platform-specific assets (rules, entry points, agent files)
126
+ 2. Clean install: remove old ~/.{tool}/skills/agent-assistant/
127
+ 3. Copy CORE_DIRS to agentAssistant path
128
+ 4. Copy commands also to "workflows" for backward compatibility
129
+ 5. Copy ROOT_FILES (README.md)
130
+ 6. Copy skills/ directory (1,430 skill folders)
131
+ 7. Copy agents/ directory (for native subagent support)
132
+ 8. Text file replacements: {TOOL} → platform name, {HOME} → ~, path macros
133
+ → completeProgress()
134
+ → verifyInstallation() # Check all copied files exist on disk
135
+ → printSummary() # Statistics: files copied, duration, errors
136
+ ```
137
+
138
+ #### Uninstall Flow
139
+ ```
140
+ resetProgress()
141
+ → Remove agentAssistant directory
142
+ → Remove platform-specific config files
143
+ → completeProgress()
144
+ → printSummary()
145
+ ```
146
+
147
+ #### List Flow
148
+ ```
149
+ For each tool in TOOLS:
150
+ → Check if agentAssistant path exists
151
+ → Print status (installed / not installed)
152
+ ```
153
+
154
+ ### 6. Progress Tracking
155
+
156
+ The CLI implements real-time progress tracking:
157
+ - **TTY mode**: Single-line progress bar with `█░` characters, percentage, file count, elapsed time
158
+ - **Non-TTY mode** (piped output): Milestone-based logging at 10% intervals
159
+ - **Throttling**: Redraws max every 50ms or on percent change
160
+ - **Verification phase**: After copy, validates all target files exist on disk
161
+ - **Summary report**: Files copied, duration, verified count, errors
162
+
163
+ ---
164
+
165
+ ## Platform Entry Points
166
+
167
+ Each platform has a unique installation target structure. The `TOOLS` config object in `cli/install.js` defines these:
168
+
169
+ ### Cursor
170
+ ```
171
+ ~/.cursor/
172
+ ├── rules/ # Global MDC rule files (from code-assistants/cursor-assistant/rules/)
173
+ ├── commands/ # Global command suggestions (from commands/)
174
+ ├── CURSOR.md # Platform entry (from code-assistants/cursor-assistant/.cursorrules)
175
+ ├── AGENT.md # Generic entry (from root AGENT.md)
176
+ ├── CLAUDE.md # Claude entry (from root CLAUDE.md)
177
+ ├── agents/ # Native subagent support (from agents/)
178
+ └── skills/
179
+ └── agent-assistant/ # Core framework
180
+ ├── agents/ # CORE_DIRS[0]
181
+ ├── rules/ # CORE_DIRS[1]
182
+ ├── documents/ # CORE_DIRS[2]
183
+ ├── commands/ # CORE_DIRS[3]
184
+ ├── matrix-skills/ # CORE_DIRS[4]
185
+ ├── workflows/ # Backward compat copy of commands/
186
+ └── README.md # ROOT_FILES[0]
187
+ ```
188
+
189
+ ### GitHub Copilot
190
+ ```
191
+ ~/.copilot/
192
+ ├── skills/
193
+ │ └── agent-assistant/ # Core framework (same structure as Cursor)
194
+ ├── commands/ # Global commands
195
+ ├── agents/ # Native subagents
196
+ ├── rules/ # Global rules
197
+ └── [VS Code prompts folder] # Platform-specific prompt location
198
+ └── agent-assistant.agent.md # Copilot agent definition
199
+ ```
200
+
201
+ The VS Code prompts folder path varies by OS:
202
+ - **macOS**: `~/Library/Application Support/Code/User/prompts/`
203
+ - **Windows**: `%APPDATA%/Code/User/prompts/`
204
+ - **Linux**: `~/.config/Code/User/prompts/`
205
+
206
+ ### Antigravity (Gemini)
207
+ ```
208
+ ~/.gemini/
209
+ ├── antigravity/
210
+ │ ├── skills/
211
+ │ │ └── agent-assistant/ # Core framework
212
+ │ └── global_workflows/ # Global workflows
213
+ ├── agents/ # Global agent configs
214
+ │ └── AntigravityGlobal.agent.md
215
+ └── GEMINI.md # Platform entry
216
+ ~/.antigravity/
217
+ ├── agents/ # User-accessible agents
218
+ └── workflows/ # User workflows
219
+ ```
220
+
221
+ ### Claude Code
222
+ ```
223
+ ~/.claude/
224
+ ├── skills/
225
+ │ └── agent-assistant/ # Core framework
226
+ ├── commands/ # Global commands
227
+ ├── agents/ # Native subagents
228
+ └── CLAUDE.md # Platform entry
229
+ ```
230
+
231
+ ### Codex
232
+ ```
233
+ ~/.codex/
234
+ ├── skills/
235
+ │ └── agent-assistant/ # Core framework
236
+ ├── commands/ # Global commands
237
+ ├── agents/ # Native subagents (TOML format from code-assistants/codex-assistant/agents/)
238
+ └── config.toml # Codex config (from code-assistants/codex-assistant/config.toml)
239
+ ```
240
+
241
+ ---
242
+
243
+ ## Build and Script Entry Points
244
+
245
+ All scripts are defined in the root `package.json`:
246
+
247
+ ### Installation Scripts
248
+ | Script | Command | Purpose |
249
+ |--------|---------|---------|
250
+ | `install:cursor` | `node cli/install.js install cursor` | Install framework for Cursor |
251
+ | `install:copilot` | `node cli/install.js install copilot` | Install framework for Copilot |
252
+ | `install:antigravity` | `node cli/install.js install antigravity` | Install framework for Antigravity |
253
+ | `install:codex` | `node cli/install.js install codex` | Install framework for Codex |
254
+ | `install:all` | `node cli/install.js install --all` | Install for all platforms |
255
+
256
+ ### Uninstall Scripts
257
+ | Script | Command | Purpose |
258
+ |--------|---------|---------|
259
+ | `uninstall:cursor` | `node cli/install.js uninstall cursor` | Uninstall from Cursor |
260
+ | `uninstall:copilot` | `node cli/install.js uninstall copilot` | Uninstall from Copilot |
261
+ | `uninstall:antigravity` | `node cli/install.js uninstall antigravity` | Uninstall from Antigravity |
262
+ | `uninstall:codex` | `node cli/install.js uninstall codex` | Uninstall from Codex |
263
+ | `uninstall:all` | `node cli/install.js uninstall --all` | Uninstall from all platforms |
264
+
265
+ ### Utility Scripts
266
+ | Script | Command | Purpose |
267
+ |--------|---------|---------|
268
+ | `list` | `node cli/install.js list` | Show installed platforms |
269
+ | `test` | `node --test cli/*.test.js` | Run test files (Node.js built-in test runner) |
270
+ | `lint` | `node --check cli/install.js && echo '✅ JavaScript syntax valid'` | Syntax check CLI |
271
+ | `lint:md` | `echo 'Run: npx markdownlint ...'` | Markdown lint hint |
272
+ | `semantic-release` | `semantic-release` | Automated version/publish |
273
+ | `prepare` | `husky install \|\| true` | Git hooks setup (fails silently if husky not available) |
274
+
275
+ ### Web Scripts (in `web/package.json`)
276
+ | Script | Command | Purpose |
277
+ |--------|---------|---------|
278
+ | `dev` | `vite` | Start Vite dev server with HMR |
279
+ | `build` | `tsc -b && vite build` | TypeScript check + production build |
280
+ | `lint` | `eslint .` | Lint web sources |
281
+ | `preview` | `vite preview` | Preview production build locally |
282
+
283
+ ---
284
+
285
+ ## Config Entry Points
286
+
287
+ Configuration files that affect system behavior:
288
+
289
+ | File | Loaded By | Purpose |
290
+ |------|-----------|---------|
291
+ | `package.json` | npm/node | Package manifest, scripts, bin, engines |
292
+ | `.releaserc.json` | semantic-release | Release automation: branch `main`, conventional commits preset, plugins chain |
293
+ | `.gitignore` | git | Exclusion rules |
294
+ | `.husky/_/` | husky | Git hooks runtime |
295
+ | `matrix-skills/_index.yaml` | HSOL (read by AI agents) | Central skill registry configuration, discovery settings |
296
+ | `matrix-skills/_dynamic.yaml` | HSOL (read by AI agents) | Dynamic/community skill manifest |
297
+ | `rules/CORE.md` | AI agents (always first) | Orchestrator protocol — paths, identity, laws |
298
+ | `web/vite.config.ts` | Vite | Build configuration with React + Tailwind plugins |
299
+ | `web/tsconfig.json` | TypeScript | Root TS config with project references |
300
+ | `web/tsconfig.app.json` | TypeScript | App compilation: ES2022, bundler resolution, react-jsx |
301
+ | `web/eslint.config.js` | ESLint v9 | Flat config with TS + React hooks + React refresh |
302
+ | `web/vercel.json` | Vercel | Deployment config with SPA rewrites |
303
+
304
+ ---
305
+
306
+ ## Web Application Entry Points
307
+
308
+ The web sub-project has its own entry chain:
309
+
310
+ ```
311
+ web/index.html # Vite HTML entry — contains <div id="root"> and <script type="module" src="/src/main.tsx">
312
+ └── web/src/main.tsx # React app mount — ReactDOM.createRoot(document.getElementById('root'))
313
+ └── web/src/App.tsx # Root component — routing, layout, providers
314
+ ├── web/src/pages/ # Route components
315
+ ├── web/src/components/ # Shared UI components
316
+ ├── web/src/hooks/ # Custom hooks
317
+ ├── web/src/lib/ # Utility functions
318
+ ├── web/src/data/ # Static content/data
319
+ ├── web/src/styles/ # Tailwind global styles
320
+ └── web/src/types/ # TypeScript definitions
321
+ ```
322
+
323
+ Build output goes to `web/dist/` with manual chunk splitting:
324
+ - `react-vendor` chunk: react, react-dom, react-router-dom
325
+ - `animation-vendor` chunk: framer-motion
326
+
327
+ ---
328
+
329
+ ## Evidence Sources
330
+
331
+ | File | Why it was used |
332
+ |------|-----------------|
333
+ | `package.json` | Verified `main`, `bin`, all scripts, engines, devDependencies |
334
+ | `cli/install.js` (lines 1-30) | Confirmed shebang, CommonJS requires (fs, path, os, readline), JSDoc usage |
335
+ | `cli/install.js` (lines 37-170) | Verified TOOLS config: 5 platforms with paths, replacements, assets |
336
+ | `cli/install.js` (lines 172-190) | Confirmed CORE_DIRS, ROOT_FILES, BUNDLED_AGENTS constants |
337
+ | `cli/install.js` (lines 460-600) | Verified install functions: progress tracking, copy logic, verification, summary |
338
+ | `AGENT.md` | Confirmed platform-agnostic Orchestrator entry |
339
+ | `CLAUDE.md` | Confirmed Claude-specific Orchestrator bootstrap with CORE.md load directive |
340
+ | `rules/CORE.md` (lines 1-40) | Confirmed v4.1, mandatory first-load, Orchestrator identity, path templates |
341
+ | `web/package.json` | Verified React 19, Vite, Tailwind, scripts (dev, build, lint, preview) |
342
+ | `web/vite.config.ts` | Confirmed plugins (react, tailwindcss), manual chunk splitting |
343
+ | `web/vercel.json` | Confirmed SPA rewrite rule: `/(.*) → /index.html` |
344
+ | `web/index.html` | Confirmed Vite HTML entry structure |
345
+ | `web/src/` directory listing | Confirmed App.tsx, main.tsx, components, pages, hooks, lib, data, styles, types |
346
+ | `.releaserc.json` | Confirmed plugin chain: commit-analyzer, release-notes, changelog, npm, git, github |