@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,582 @@
|
|
|
1
|
+
# Agent Assistant — Key Modules
|
|
2
|
+
|
|
3
|
+
> **Purpose**: Per-module breakdown of purpose, exports, dependencies, and internal structure for all major modules in the framework
|
|
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
|
+
- [Module 1: CLI Installer (cli/)](#module-1-cli-installer-cli)
|
|
14
|
+
- [Module 2: Agents (agents/)](#module-2-agents-agents)
|
|
15
|
+
- [Module 3: Commands (commands/)](#module-3-commands-commands)
|
|
16
|
+
- [Module 4: Rules (rules/)](#module-4-rules-rules)
|
|
17
|
+
- [Module 5: Matrix Skills — HSOL (matrix-skills/)](#module-5-matrix-skills--hsol-matrix-skills)
|
|
18
|
+
- [Module 6: Skills (skills/)](#module-6-skills-skills)
|
|
19
|
+
- [Module 7: Code Assistants (code-assistants/)](#module-7-code-assistants-code-assistants)
|
|
20
|
+
- [Module 8: Platform Entry Points (Root Markdown)](#module-8-platform-entry-points-root-markdown)
|
|
21
|
+
- [Module 9: Web Marketing Site (web/)](#module-9-web-marketing-site-web)
|
|
22
|
+
- [Module 10: Documents (documents/)](#module-10-documents-documents)
|
|
23
|
+
- [Module Dependency Map](#module-dependency-map)
|
|
24
|
+
- [Evidence Sources](#evidence-sources)
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
## Overview
|
|
29
|
+
|
|
30
|
+
Agent Assistant operates as a "content framework" — the majority of its modules are Markdown/YAML files interpreted by AI coding tools. Only two modules contain executable code: the CLI installer (`cli/`) and the web marketing site (`web/`). All other modules are declarative configuration consumed by AI assistants at prompt-interpretation time.
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
## Module 1: CLI Installer (cli/)
|
|
35
|
+
|
|
36
|
+
### Purpose
|
|
37
|
+
The sole executable module in the published npm package. Copies framework files from the package to platform-specific directories on the user's machine, with placeholder replacement for cross-platform compatibility.
|
|
38
|
+
|
|
39
|
+
### Files
|
|
40
|
+
|
|
41
|
+
| File | Size | Role |
|
|
42
|
+
|------|------|------|
|
|
43
|
+
| `install.js` | ~600 LOC | Main CLI entry, all logic in one file |
|
|
44
|
+
| `install.test.js.example` | Template | Example test file (not active) |
|
|
45
|
+
| `README.md` | Doc | CLI-specific usage guide |
|
|
46
|
+
|
|
47
|
+
### Internal Structure of install.js
|
|
48
|
+
|
|
49
|
+
The file is organized into clearly labeled sections:
|
|
50
|
+
|
|
51
|
+
| Section | Lines (approx.) | Contents |
|
|
52
|
+
|---------|-----------------|----------|
|
|
53
|
+
| Header / JSDoc | 1–30 | Shebang, documentation comment, usage examples |
|
|
54
|
+
| Imports | 31–34 | `node:fs`, `node:path`, `node:os`, `node:readline` |
|
|
55
|
+
| Configuration | 35–210 | `HOME`, `ROOT`, `getVSCodePromptsFolder()`, `TOOLS` object (5 platforms), `CORE_DIRS`, `ROOT_FILES`, `BUNDLED_AGENTS` |
|
|
56
|
+
| Progress Tracking | 210–320 | `progressState`, `resetProgress()`, `countFiles()`, `drawProgress()`, `updateProgress()`, `completeProgress()`, `logError()` |
|
|
57
|
+
| File Operations | 320–460 | `ensureDir()`, `copyWithReplace()`, `copyFileWithReplace()`, `removeDir()`, `removeFile()`, `formatNumber()`, `estimateInstallFiles()`, `verifyInstallation()`, `printSummary()` |
|
|
58
|
+
| Install Functions | 460–end | `installCursor()`, `installCopilot()`, `installAntigravity()`, `installClaude()`, `installCodex()` + corresponding uninstall functions, `list()`, `main()` |
|
|
59
|
+
|
|
60
|
+
### Key Data Structures
|
|
61
|
+
|
|
62
|
+
**TOOLS Config Object** — Defines per-platform installation configuration:
|
|
63
|
+
|
|
64
|
+
```javascript
|
|
65
|
+
TOOLS = {
|
|
66
|
+
cursor: {
|
|
67
|
+
name: 'Cursor',
|
|
68
|
+
description: 'Cursor AI Editor',
|
|
69
|
+
paths: {
|
|
70
|
+
editorHome: '~/.cursor',
|
|
71
|
+
rules: '~/.cursor/rules',
|
|
72
|
+
skills: '~/.cursor/skills',
|
|
73
|
+
agents: '~/.cursor/agents',
|
|
74
|
+
commands: '~/.cursor/commands',
|
|
75
|
+
agentAssistant: '~/.cursor/skills/agent-assistant'
|
|
76
|
+
},
|
|
77
|
+
replacements: { '{TOOL}': 'cursor', ... },
|
|
78
|
+
assets: { rules: '...', cursorRules: '...' }
|
|
79
|
+
},
|
|
80
|
+
// copilot, antigravity, claude, codex follow same shape
|
|
81
|
+
}
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
**CORE_DIRS** — Directories copied into the framework install location:
|
|
85
|
+
```javascript
|
|
86
|
+
['agents', 'rules', 'documents', 'commands', 'matrix-skills']
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
**BUNDLED_AGENTS** — 20 agent filenames for cleanup (remove only framework agents, preserve user-custom):
|
|
90
|
+
```javascript
|
|
91
|
+
['backend-engineer.md', 'brainstormer.md', ..., 'tester.md']
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Dependencies
|
|
95
|
+
- **Runtime**: Zero external dependencies. Uses only Node.js built-ins (`node:fs`, `node:path`, `node:os`, `node:readline`)
|
|
96
|
+
- **Minimum Node version**: 18.0.0 (enforced in `package.json` `engines`)
|
|
97
|
+
|
|
98
|
+
### Security Measures
|
|
99
|
+
- Symbolic links are explicitly skipped during file copy (`entry.isSymbolicLink()` check) to prevent path traversal attacks
|
|
100
|
+
- Hidden files (`.` prefix) and `node_modules` are skipped during recursive copy
|
|
101
|
+
- File writes use `fsync` for reliability: `fs.openSync()` → `fs.writeSync()` → `fs.fsyncSync()` → `fs.closeSync()`
|
|
102
|
+
|
|
103
|
+
---
|
|
104
|
+
|
|
105
|
+
## Module 2: Agents (agents/)
|
|
106
|
+
|
|
107
|
+
### Purpose
|
|
108
|
+
Defines specialist agent personas that the Orchestrator delegates tasks to. Each agent file is a Markdown document with YAML frontmatter specifying capabilities, tool access, and HSOL profile for skill resolution.
|
|
109
|
+
|
|
110
|
+
### Structure
|
|
111
|
+
|
|
112
|
+
| Category | Count | Location |
|
|
113
|
+
|----------|-------|----------|
|
|
114
|
+
| Solo agents | 21 | `agents/*.md` |
|
|
115
|
+
| Team directories | 17 | `agents/teams/{team-name}/` |
|
|
116
|
+
| Team roles per team | 3 | `executor.md`, `reviewer.md`, `techlead.md` |
|
|
117
|
+
| Team agent files | 51 | `agents/teams/*/` |
|
|
118
|
+
| **Total** | **72** | |
|
|
119
|
+
|
|
120
|
+
### Agent File Format (from AGENT-TEMPLATE.md)
|
|
121
|
+
|
|
122
|
+
Required YAML frontmatter fields:
|
|
123
|
+
- `name` — Agent identifier
|
|
124
|
+
- `description` — One-line purpose
|
|
125
|
+
- `profile` — HSOL profile string: `"{domain}:{category}"` (e.g., `"backend:execution"`)
|
|
126
|
+
- `tools` — Available tools list
|
|
127
|
+
- `handoffs` — Agents this agent can delegate to
|
|
128
|
+
- `version` — Agent version
|
|
129
|
+
- `category` — One of: `execution`, `planning`, `validation`, `research`, `debugging`, `orchestration`
|
|
130
|
+
|
|
131
|
+
Required Markdown sections (in order):
|
|
132
|
+
1. Cognitive Anchor (binding directive)
|
|
133
|
+
2. Identity (role description)
|
|
134
|
+
3. Matrix skill discovery profile
|
|
135
|
+
4. Execution workflow
|
|
136
|
+
5. Output format
|
|
137
|
+
|
|
138
|
+
### Solo Agent Roster
|
|
139
|
+
|
|
140
|
+
| Agent | Domain Focus |
|
|
141
|
+
|-------|-------------|
|
|
142
|
+
| `backend-engineer` | Server-side implementation |
|
|
143
|
+
| `brainstormer` | Ideation and creative solutions |
|
|
144
|
+
| `business-analyst` | Business requirements analysis |
|
|
145
|
+
| `database-architect` | Database design and optimization |
|
|
146
|
+
| `debugger` | Bug investigation and resolution |
|
|
147
|
+
| `designer` | UI/UX design |
|
|
148
|
+
| `devops-engineer` | CI/CD and infrastructure |
|
|
149
|
+
| `docs-manager` | Documentation architecture |
|
|
150
|
+
| `frontend-engineer` | Client-side implementation |
|
|
151
|
+
| `game-engineer` | Game development |
|
|
152
|
+
| `mobile-engineer` | Mobile app development |
|
|
153
|
+
| `performance-engineer` | Performance optimization |
|
|
154
|
+
| `planner` | Task planning and decomposition |
|
|
155
|
+
| `project-manager` | Project coordination |
|
|
156
|
+
| `reporter` | Report generation |
|
|
157
|
+
| `researcher` | Research and analysis |
|
|
158
|
+
| `reviewer` | Code review |
|
|
159
|
+
| `scouter` | Technology scouting |
|
|
160
|
+
| `security-engineer` | Security analysis and hardening |
|
|
161
|
+
| `tech-lead` | Architecture decisions |
|
|
162
|
+
| `tester` | Testing strategy and execution |
|
|
163
|
+
|
|
164
|
+
### Team Directory Structure
|
|
165
|
+
|
|
166
|
+
Each team has 3 role files with consistent naming:
|
|
167
|
+
|
|
168
|
+
| Team | executor.md | reviewer.md | techlead.md |
|
|
169
|
+
|------|------------|-------------|-------------|
|
|
170
|
+
| backend-team | ✓ | ✓ | ✓ |
|
|
171
|
+
| database-team | ✓ | ✓ | ✓ |
|
|
172
|
+
| debug-team | ✓ | ✓ | ✓ |
|
|
173
|
+
| design-team | ✓ | ✓ | ✓ |
|
|
174
|
+
| devops-team | ✓ | ✓ | ✓ |
|
|
175
|
+
| docs-team | ✓ | ✓ | ✓ |
|
|
176
|
+
| frontend-team | ✓ | ✓ | ✓ |
|
|
177
|
+
| fullstack-team | ✓ | ✓ | ✓ |
|
|
178
|
+
| game-team | ✓ | ✓ | ✓ |
|
|
179
|
+
| mobile-team | ✓ | ✓ | ✓ |
|
|
180
|
+
| performance-team | ✓ | ✓ | ✓ |
|
|
181
|
+
| planning-team | ✓ | ✓ | ✓ |
|
|
182
|
+
| project-team | ✓ | ✓ | ✓ |
|
|
183
|
+
| qa-team | ✓ | ✓ | ✓ |
|
|
184
|
+
| report-team | ✓ | ✓ | ✓ |
|
|
185
|
+
| research-team | ✓ | ✓ | ✓ |
|
|
186
|
+
| security-team | ✓ | ✓ | ✓ |
|
|
187
|
+
|
|
188
|
+
### Dependencies
|
|
189
|
+
- Consumed by: AI coding tools at runtime, `rules/AGENTS.md`, `rules/TEAMS.md`
|
|
190
|
+
- Depends on: `AGENT-TEMPLATE.md` (format), `matrix-skills/` (profile-based skill injection)
|
|
191
|
+
|
|
192
|
+
---
|
|
193
|
+
|
|
194
|
+
## Module 3: Commands (commands/)
|
|
195
|
+
|
|
196
|
+
### Purpose
|
|
197
|
+
Implements the command routing system — the primary user-facing interface. Users invoke commands like `/cook`, `/fix`, `/plan` and the Orchestrator loads the corresponding command file, optionally with a variant modifier.
|
|
198
|
+
|
|
199
|
+
### Structure
|
|
200
|
+
|
|
201
|
+
**14 Router Files** (at `commands/` root):
|
|
202
|
+
|
|
203
|
+
| Command | Variant Subdirectory | Variants |
|
|
204
|
+
|---------|---------------------|----------|
|
|
205
|
+
| `ask.md` | `ask/` | `fast`, `hard` |
|
|
206
|
+
| `auto.md` | — | (no variants) |
|
|
207
|
+
| `brainstorm.md` | `brainstorm/` | `fast`, `hard`, `team` |
|
|
208
|
+
| `code.md` | `code/` | `fast`, `focus`, `hard`, `team` |
|
|
209
|
+
| `cook.md` | `cook/` | `fast`, `focus`, `hard`, `team` |
|
|
210
|
+
| `debug.md` | `debug/` | `fast`, `focus`, `hard`, `team` |
|
|
211
|
+
| `deploy.md` | `deploy/` | `check`, `preview`, `production`, `rollback` |
|
|
212
|
+
| `design.md` | `design/` | `fast`, `focus`, `hard`, `team` |
|
|
213
|
+
| `docs.md` | `docs/` | `audit`, `business`, `core` |
|
|
214
|
+
| `fix.md` | `fix/` | `fast`, `focus`, `hard`, `team` |
|
|
215
|
+
| `plan.md` | `plan/` | `fast`, `focus`, `hard`, `team` |
|
|
216
|
+
| `report.md` | `report/` | `fast`, `focus`, `hard`, `team` |
|
|
217
|
+
| `review.md` | `review/` | `fast`, `hard`, `team` |
|
|
218
|
+
| `test.md` | `test/` | `fast`, `focus`, `hard`, `team` |
|
|
219
|
+
|
|
220
|
+
**Variant Pattern Categories**:
|
|
221
|
+
|
|
222
|
+
| Pattern | Variants | Used By |
|
|
223
|
+
|---------|----------|---------|
|
|
224
|
+
| Standard (4 variants) | `fast`, `focus`, `hard`, `team` | code, cook, debug, design, fix, plan, report, test |
|
|
225
|
+
| Standard-3 (no focus) | `fast`, `hard`, `team` | brainstorm, review |
|
|
226
|
+
| Minimal (2 variants) | `fast`, `hard` | ask |
|
|
227
|
+
| Deploy-specific | `check`, `preview`, `production`, `rollback` | deploy |
|
|
228
|
+
| Docs-specific | `audit`, `business`, `core` | docs |
|
|
229
|
+
| No variants | — | auto |
|
|
230
|
+
|
|
231
|
+
**Total**: 14 router files + 47 variant files = 61 command Markdown files
|
|
232
|
+
|
|
233
|
+
### Routing Logic
|
|
234
|
+
The Orchestrator (defined in `rules/CORE.md`) routes commands as follows:
|
|
235
|
+
1. User invokes `/command` or `/command:variant`
|
|
236
|
+
2. Orchestrator loads `commands/{command}.md` as the router
|
|
237
|
+
3. If variant specified, loads `commands/{command}/{variant}.md`
|
|
238
|
+
4. Natural language mapping: "implement/build/create" → `/cook` or `/code`, "fix/bug" → `/fix`, "plan" → `/plan`
|
|
239
|
+
|
|
240
|
+
### Dependencies
|
|
241
|
+
- Referenced by: `rules/CORE.md` (command routing table), `rules/REFERENCE.md` (quick lookup)
|
|
242
|
+
- Commands are copied to both `commands/` and `workflows/` during installation for backward compatibility
|
|
243
|
+
- Team variants (`:team`) depend on `rules/TEAMS.md` for multi-agent coordination
|
|
244
|
+
|
|
245
|
+
---
|
|
246
|
+
|
|
247
|
+
## Module 4: Rules (rules/)
|
|
248
|
+
|
|
249
|
+
### Purpose
|
|
250
|
+
Defines the Orchestrator's operating protocol — the "operating system" for the AI agent. Rules are loaded on-demand to conserve context window space.
|
|
251
|
+
|
|
252
|
+
### Files
|
|
253
|
+
|
|
254
|
+
| File | Version | Load Priority | Purpose |
|
|
255
|
+
|------|---------|--------------|---------|
|
|
256
|
+
| `CORE.md` | v4.1 | **Mandatory — always first** | Identity, paths, 10 Laws, prohibitions, self-check, platform resolution |
|
|
257
|
+
| `PHASES.md` | — | On demand (running phases) | Phase execution workflow, output format requirements, exit criteria |
|
|
258
|
+
| `AGENTS.md` | — | On demand (delegating) | Tiered execution: Tier 1 (sub-agent), Tier 2 (embodiment fallback) |
|
|
259
|
+
| `SKILLS.md` | — | On demand (skill resolution) | HSOL protocol: matrix-first resolution, dynamic discovery, fitness scoring |
|
|
260
|
+
| `TEAMS.md` | — | On demand (team commands) | Team execution protocol for `:team` variant commands |
|
|
261
|
+
| `ERRORS.md` | — | On demand (errors) | Error recovery procedures, fallback strategies |
|
|
262
|
+
| `REFERENCE.md` | — | On demand (quick lookup) | Quick lookup tables: commands, agents, skills mapping |
|
|
263
|
+
|
|
264
|
+
### Key Concepts from CORE.md
|
|
265
|
+
|
|
266
|
+
**Identity Binding**: The Orchestrator is explicitly prohibited from writing code, debugging, testing, or designing directly. It must delegate all implementation to specialist agents.
|
|
267
|
+
|
|
268
|
+
**Path Resolution**: Uses `{TOOL}` placeholder replaced at install time:
|
|
269
|
+
| Platform | `{TOOL}` Value | Install Path |
|
|
270
|
+
|----------|---------------|--------------|
|
|
271
|
+
| Cursor | `cursor` | `~/.cursor/skills/agent-assistant/` |
|
|
272
|
+
| Copilot | `copilot` | `~/.copilot/skills/agent-assistant/` |
|
|
273
|
+
| Antigravity | `gemini/antigravity` | `~/.gemini/antigravity/skills/agent-assistant/` |
|
|
274
|
+
| Claude | `claude` | `~/.claude/skills/agent-assistant/` |
|
|
275
|
+
| Codex | `codex` | `~/.codex/skills/agent-assistant/` |
|
|
276
|
+
|
|
277
|
+
**Tiered Execution** (from AGENTS.md):
|
|
278
|
+
- **Tier 1**: Use sub-agent (isolated context) when `runSubagent` capability exists
|
|
279
|
+
- **Tier 2**: Fallback to embodiment (Orchestrator assumes agent role) when Tier 1 unavailable
|
|
280
|
+
|
|
281
|
+
### Dependencies
|
|
282
|
+
- Loaded by: Platform entry point files (AGENT.md, CLAUDE.md, etc.)
|
|
283
|
+
- References: `commands/`, `agents/`, `matrix-skills/`, `skills/`
|
|
284
|
+
|
|
285
|
+
---
|
|
286
|
+
|
|
287
|
+
## Module 5: Matrix Skills — HSOL (matrix-skills/)
|
|
288
|
+
|
|
289
|
+
### Purpose
|
|
290
|
+
Implements the Hybrid Skill Orchestration Layer (HSOL) — a two-layer system for dynamically resolving and injecting skills into agent contexts based on their profile and the task at hand.
|
|
291
|
+
|
|
292
|
+
### Architecture
|
|
293
|
+
|
|
294
|
+
```
|
|
295
|
+
HSOL Resolution Flow:
|
|
296
|
+
Agent Request → Profile ('backend:execution')
|
|
297
|
+
↓
|
|
298
|
+
Static Layer: Load domain YAML (backend.yaml)
|
|
299
|
+
↓
|
|
300
|
+
Match skills by relevance_mapping + priority
|
|
301
|
+
↓
|
|
302
|
+
Dynamic Layer: Check _dynamic.yaml for community skills
|
|
303
|
+
↓
|
|
304
|
+
If matrix fitness < 0.8: Run find-skills discovery
|
|
305
|
+
↓
|
|
306
|
+
Inject matched SKILL.md files into agent context
|
|
307
|
+
```
|
|
308
|
+
|
|
309
|
+
### Files
|
|
310
|
+
|
|
311
|
+
| File | Purpose |
|
|
312
|
+
|------|---------|
|
|
313
|
+
| `_index.yaml` | Master HSOL configuration v1.1: enables HSOL, sets discovery parameters, defines `find-skills` integration commands, configures async threshold (0.8), variant applicability (`hard`, `focus` only — `fast` skips discovery) |
|
|
314
|
+
| `_dynamic.yaml` | Manifest for community-installed skills added via `npx skills add` |
|
|
315
|
+
| 19 domain `.yaml` files | Pre-curated skill registries mapped to agent profiles |
|
|
316
|
+
|
|
317
|
+
### Domain Registry Files
|
|
318
|
+
|
|
319
|
+
| Domain File | Skill Area |
|
|
320
|
+
|-------------|-----------|
|
|
321
|
+
| `ai-ml.yaml` | AI and machine learning |
|
|
322
|
+
| `architecture.yaml` | Software architecture |
|
|
323
|
+
| `backend.yaml` | Server-side development |
|
|
324
|
+
| `cloud.yaml` | Cloud infrastructure |
|
|
325
|
+
| `data.yaml` | Data engineering |
|
|
326
|
+
| `design.yaml` | UI/UX design |
|
|
327
|
+
| `devops.yaml` | DevOps and CI/CD |
|
|
328
|
+
| `frontend.yaml` | Client-side development |
|
|
329
|
+
| `gaming.yaml` | Game development |
|
|
330
|
+
| `languages.yaml` | Programming language specifics |
|
|
331
|
+
| `management.yaml` | Project management |
|
|
332
|
+
| `mcp.yaml` | Model Context Protocol integration |
|
|
333
|
+
| `mobile.yaml` | Mobile development |
|
|
334
|
+
| `performance.yaml` | Performance optimization |
|
|
335
|
+
| `planning.yaml` | Planning and strategy |
|
|
336
|
+
| `quality.yaml` | Quality assurance |
|
|
337
|
+
| `research.yaml` | Research methodologies |
|
|
338
|
+
| `security.yaml` | Security practices |
|
|
339
|
+
| `tools.yaml` | Development tooling |
|
|
340
|
+
|
|
341
|
+
### HSOL Configuration Highlights (from _index.yaml)
|
|
342
|
+
|
|
343
|
+
| Setting | Value | Meaning |
|
|
344
|
+
|---------|-------|---------|
|
|
345
|
+
| `version` | 1.1 | HSOL protocol version |
|
|
346
|
+
| `total_matrix_skills` | 1,430 | Total pre-curated skills |
|
|
347
|
+
| `async_threshold` | 0.8 | Matrix fitness above this skips dynamic discovery |
|
|
348
|
+
| `apply_for_variants` | `["hard", "focus"]` | Dynamic discovery only runs for these variants |
|
|
349
|
+
| `timeout_ms` | 5,000 | Discovery timeout |
|
|
350
|
+
| `cache_ttl_seconds` | 3,600 | Discovery cache duration |
|
|
351
|
+
| `find-skills` CLI commands | `npx skills find`, `npx skills add`, `npx skills check`, `npx skills update` | External skill service integration |
|
|
352
|
+
|
|
353
|
+
### Dependencies
|
|
354
|
+
- Referenced by: `rules/SKILLS.md` (resolution protocol), agents (via `profile` frontmatter)
|
|
355
|
+
- References: `skills/` directory (resolved skill folders), `skills/find-skills/SKILL.md` (discovery skill)
|
|
356
|
+
- External: `https://skills.sh/` (browse URL for dynamic discovery)
|
|
357
|
+
- Referenced in: `documents/SMART-SKILL-ORCHESTRATION-BLUEPRINT.md`
|
|
358
|
+
|
|
359
|
+
---
|
|
360
|
+
|
|
361
|
+
## Module 6: Skills (skills/)
|
|
362
|
+
|
|
363
|
+
### Purpose
|
|
364
|
+
Contains 1,430 individual skill folders, each containing a `SKILL.md` file that defines the skill's purpose, best practices, and usage patterns. Skills are the atomic units of knowledge injected into agent contexts by the HSOL.
|
|
365
|
+
|
|
366
|
+
### Structure
|
|
367
|
+
```
|
|
368
|
+
skills/
|
|
369
|
+
├── 00-andruia-consultant/
|
|
370
|
+
│ └── SKILL.md
|
|
371
|
+
├── 007/
|
|
372
|
+
│ └── SKILL.md
|
|
373
|
+
├── 10-andruia-skill-smith/
|
|
374
|
+
│ └── SKILL.md
|
|
375
|
+
├── ... (1,430 total)
|
|
376
|
+
└── find-skills/
|
|
377
|
+
└── SKILL.md # Special: HSOL dynamic discovery
|
|
378
|
+
```
|
|
379
|
+
|
|
380
|
+
### Special Skill: find-skills
|
|
381
|
+
|
|
382
|
+
The `find-skills/SKILL.md` skill is referenced by the HSOL `_index.yaml` as the dynamic discovery mechanism. It defines how to search for, install, and manage community skills from the external `skills.sh` service.
|
|
383
|
+
|
|
384
|
+
### Dependencies
|
|
385
|
+
- Resolved by: `matrix-skills/` YAML registries via HSOL profile matching
|
|
386
|
+
- Installed to: `~/.{tool}/skills/` (alongside the `agent-assistant/` framework directory)
|
|
387
|
+
|
|
388
|
+
---
|
|
389
|
+
|
|
390
|
+
## Module 7: Code Assistants (code-assistants/)
|
|
391
|
+
|
|
392
|
+
### Purpose
|
|
393
|
+
Stores platform-specific template files and assets that extend the base framework for each supported AI coding tool. These files handle platform-specific conventions, file formats, and directory structures.
|
|
394
|
+
|
|
395
|
+
### Platform Breakdown
|
|
396
|
+
|
|
397
|
+
#### cursor-assistant/
|
|
398
|
+
|
|
399
|
+
| Asset | Purpose |
|
|
400
|
+
|-------|---------|
|
|
401
|
+
| `.cursorrules` | Cursor-specific rules file; installed as `CURSOR.md` into `~/.cursor/` |
|
|
402
|
+
| `rules/` | MDC (Markdown Cursor) rule files for Cursor's native rules system |
|
|
403
|
+
|
|
404
|
+
#### copilot-assistant/
|
|
405
|
+
|
|
406
|
+
| Asset | Purpose |
|
|
407
|
+
|-------|---------|
|
|
408
|
+
| `agent-assistant.agent.md` | Copilot agent mode specification file; installed to VS Code prompts folder |
|
|
409
|
+
|
|
410
|
+
#### antigravity-assistant/
|
|
411
|
+
|
|
412
|
+
| Asset | Purpose |
|
|
413
|
+
|-------|---------|
|
|
414
|
+
| `GEMINI.md` | Gemini-specific entry point; installed to `~/.gemini/` |
|
|
415
|
+
| `AntigravityGlobal.agent.md` | Global agent file; installed to `~/.gemini/agents/` |
|
|
416
|
+
|
|
417
|
+
#### claude-assistant/
|
|
418
|
+
|
|
419
|
+
| Asset | Purpose |
|
|
420
|
+
|-------|---------|
|
|
421
|
+
| `CLAUDE.md` | Claude Code-specific entry point; installed to `~/.claude/` |
|
|
422
|
+
|
|
423
|
+
#### codex-assistant/
|
|
424
|
+
|
|
425
|
+
| Asset | Purpose |
|
|
426
|
+
|-------|---------|
|
|
427
|
+
| `CODEX.md` | Codex-specific entry point; installed to `~/.codex/` |
|
|
428
|
+
| `config.toml` | Codex configuration in TOML format |
|
|
429
|
+
| `agents/` | Codex-specific agent definitions |
|
|
430
|
+
| `skills/` | Codex-specific skill overrides |
|
|
431
|
+
|
|
432
|
+
### Dependencies
|
|
433
|
+
- Consumed by: `cli/install.js` (TOOLS config references these paths via `assets` property)
|
|
434
|
+
- Each platform template references: root `AGENT.md`, `CLAUDE.md`, framework rules
|
|
435
|
+
|
|
436
|
+
---
|
|
437
|
+
|
|
438
|
+
## Module 8: Platform Entry Points (Root Markdown)
|
|
439
|
+
|
|
440
|
+
### Purpose
|
|
441
|
+
Root-level Markdown files serve as the "boot configuration" for each AI coding tool. When the AI tool starts, it reads the appropriate file to initialize the Orchestrator role with platform-specific path resolution.
|
|
442
|
+
|
|
443
|
+
### Files
|
|
444
|
+
|
|
445
|
+
| File | Consumed By | Key Content |
|
|
446
|
+
|------|-----------|-------------|
|
|
447
|
+
| `AGENT.md` | All platforms (generic) | Orchestrator identity, command routing, path definitions with `{TOOL}` placeholders |
|
|
448
|
+
| `CLAUDE.md` | Claude Code | Claude-specific orchestrator boot instructions |
|
|
449
|
+
| `COPILOT.md` | GitHub Copilot | Copilot-specific entry point |
|
|
450
|
+
| `CURSOR.md` | Cursor | Cursor-specific rules and conventions |
|
|
451
|
+
| `CODEX.md` | OpenAI Codex | Codex-specific entry point |
|
|
452
|
+
| `GEMINI.md` | Antigravity/Gemini | Gemini-specific entry point |
|
|
453
|
+
| `AGENT-TEMPLATE.md` | Developers | Template for creating new agent files (not installed) |
|
|
454
|
+
|
|
455
|
+
### Dependencies
|
|
456
|
+
- Loaded by: AI coding tools on startup
|
|
457
|
+
- References: `rules/CORE.md` (loaded first), `commands/`, `agents/`
|
|
458
|
+
- Installed copies are modified by `cli/install.js` with platform-specific replacements
|
|
459
|
+
|
|
460
|
+
---
|
|
461
|
+
|
|
462
|
+
## Module 9: Web Marketing Site (web/)
|
|
463
|
+
|
|
464
|
+
### Purpose
|
|
465
|
+
A standalone React 19 + Vite + Tailwind CSS marketing website for the agent-assistant project. Deployed to Vercel. Not part of the published npm package.
|
|
466
|
+
|
|
467
|
+
### Technology Stack
|
|
468
|
+
|
|
469
|
+
| Technology | Version | Role |
|
|
470
|
+
|------------|---------|------|
|
|
471
|
+
| React | 19.2.0 | UI framework |
|
|
472
|
+
| React DOM | 19.2.0 | DOM rendering |
|
|
473
|
+
| React Router DOM | 7.13.0 | Client-side routing |
|
|
474
|
+
| Framer Motion | 12.29.2 | Animations |
|
|
475
|
+
| Lucide React | 0.563.0 | Icon library |
|
|
476
|
+
| @xyflow/react | 12.10.0 | Flow/graph visualization |
|
|
477
|
+
| clsx | 2.1.1 | Class name utility |
|
|
478
|
+
| react-helmet-async | 2.0.5 | Document head management |
|
|
479
|
+
| Vite | (devDep) | Build tool |
|
|
480
|
+
| Tailwind CSS v4 | (via @tailwindcss/vite) | CSS framework |
|
|
481
|
+
| TypeScript | (devDep) | Type-checking |
|
|
482
|
+
| ESLint v9 | (devDep) | Linting |
|
|
483
|
+
|
|
484
|
+
### Source Structure
|
|
485
|
+
|
|
486
|
+
| Path | Purpose |
|
|
487
|
+
|------|---------|
|
|
488
|
+
| `src/main.tsx` | React DOM entry point |
|
|
489
|
+
| `src/App.tsx` | Root component with routing |
|
|
490
|
+
| `src/components/` | Reusable UI components |
|
|
491
|
+
| `src/pages/` | Route page components |
|
|
492
|
+
| `src/data/` | Static data files |
|
|
493
|
+
| `src/hooks/` | Custom React hooks |
|
|
494
|
+
| `src/lib/` | Utility libraries |
|
|
495
|
+
| `src/styles/` | CSS / Tailwind styles |
|
|
496
|
+
| `src/types/` | TypeScript type definitions |
|
|
497
|
+
|
|
498
|
+
### Build Configuration
|
|
499
|
+
- **Vite plugins**: `@vitejs/plugin-react`, `@tailwindcss/vite`
|
|
500
|
+
- **Build target**: `esnext`
|
|
501
|
+
- **Minifier**: `esbuild`
|
|
502
|
+
- **Code splitting**: Manual chunks for `react-vendor` (react, react-dom, react-router-dom) and `animation-vendor` (framer-motion)
|
|
503
|
+
- **TypeScript**: ES2022 target, bundler module resolution, React JSX transform
|
|
504
|
+
- **ESLint**: Flat config with `@eslint/js`, `typescript-eslint`, `eslint-plugin-react-hooks`, `eslint-plugin-react-refresh`
|
|
505
|
+
|
|
506
|
+
### Deployment
|
|
507
|
+
- **Platform**: Vercel
|
|
508
|
+
- **Config**: `vercel.json` with SPA rewrite: all routes → `/index.html`
|
|
509
|
+
|
|
510
|
+
### Dependencies
|
|
511
|
+
- Independent from main package (separate `package.json`)
|
|
512
|
+
- Not included in npm `files` array
|
|
513
|
+
|
|
514
|
+
---
|
|
515
|
+
|
|
516
|
+
## Module 10: Documents (documents/)
|
|
517
|
+
|
|
518
|
+
### Purpose
|
|
519
|
+
Houses project-level documentation that goes beyond the README. Provides architectural assessments and knowledge bases for contributors.
|
|
520
|
+
|
|
521
|
+
### Files
|
|
522
|
+
|
|
523
|
+
| File | Purpose |
|
|
524
|
+
|------|---------|
|
|
525
|
+
| `HSOL-ASSESSMENT.md` | Evaluation and assessment of the Hybrid Skill Orchestration Layer |
|
|
526
|
+
| `SMART-SKILL-ORCHESTRATION-BLUEPRINT.md` | Architectural blueprint for the HSOL skill resolution system |
|
|
527
|
+
| `knowledge-source-base/` | This comprehensive documentation set |
|
|
528
|
+
|
|
529
|
+
### Dependencies
|
|
530
|
+
- Referenced by: `matrix-skills/_index.yaml` (links to blueprint), `rules/SKILLS.md`
|
|
531
|
+
- Included in npm `files` array and `CORE_DIRS` (copied during installation)
|
|
532
|
+
|
|
533
|
+
---
|
|
534
|
+
|
|
535
|
+
## Module Dependency Map
|
|
536
|
+
|
|
537
|
+
```
|
|
538
|
+
Platform Markdown Files (AGENT.md, CLAUDE.md, etc.)
|
|
539
|
+
└── rules/CORE.md (mandatory first load)
|
|
540
|
+
├── rules/PHASES.md (phase execution)
|
|
541
|
+
├── rules/AGENTS.md (delegation protocol)
|
|
542
|
+
│ └── agents/*.md (specialist agents)
|
|
543
|
+
│ └── agents/teams/*/ (team variants)
|
|
544
|
+
├── rules/SKILLS.md (skill resolution)
|
|
545
|
+
│ └── matrix-skills/_index.yaml (HSOL config)
|
|
546
|
+
│ ├── matrix-skills/{domain}.yaml (static layer)
|
|
547
|
+
│ ├── matrix-skills/_dynamic.yaml (dynamic layer)
|
|
548
|
+
│ └── skills/find-skills/SKILL.md (discovery)
|
|
549
|
+
│ └── skills/*/ (1,430 skill definitions)
|
|
550
|
+
├── rules/TEAMS.md (team coordination)
|
|
551
|
+
├── rules/ERRORS.md (error handling)
|
|
552
|
+
└── rules/REFERENCE.md (lookup tables)
|
|
553
|
+
└── commands/*.md + commands/*/ (command routing)
|
|
554
|
+
|
|
555
|
+
cli/install.js (independent entry — copies all above into tool directories)
|
|
556
|
+
└── code-assistants/*/ (platform-specific assets)
|
|
557
|
+
|
|
558
|
+
web/ (independent — not connected to framework modules)
|
|
559
|
+
```
|
|
560
|
+
|
|
561
|
+
---
|
|
562
|
+
|
|
563
|
+
## Evidence Sources
|
|
564
|
+
|
|
565
|
+
| File | Why it was used |
|
|
566
|
+
|------|-----------------|
|
|
567
|
+
| `cli/install.js` (full file) | Internal structure, TOOLS config, CORE_DIRS, BUNDLED_AGENTS, file operation functions, install functions, security measures |
|
|
568
|
+
| `package.json` | Module entry points (`main`, `bin`), zero production deps, engine constraint |
|
|
569
|
+
| `AGENT-TEMPLATE.md` | Agent file format: required frontmatter fields, profile values, section order |
|
|
570
|
+
| `agents/` listing | Solo agent roster (21 files) |
|
|
571
|
+
| `agents/teams/` listing | 17 team directories × 3 roles |
|
|
572
|
+
| `commands/` and `commands/*/` listings | Router files and variant structure |
|
|
573
|
+
| `rules/CORE.md` | Orchestrator identity, path resolution, platform table, tiered execution |
|
|
574
|
+
| `matrix-skills/_index.yaml` | HSOL v1.1 config, total skills, discovery settings, variant applicability |
|
|
575
|
+
| `code-assistants/*/` listings | Per-platform asset files |
|
|
576
|
+
| `web/package.json` | Web app dependencies and versions |
|
|
577
|
+
| `web/vite.config.ts` | Build plugins, chunk splitting, targets |
|
|
578
|
+
| `web/tsconfig.app.json` | TypeScript compiler options |
|
|
579
|
+
| `web/eslint.config.js` | ESLint flat config plugins |
|
|
580
|
+
| `web/vercel.json` | Deployment configuration |
|
|
581
|
+
| `web/src/` listing | Source directory organization |
|
|
582
|
+
| `documents/` listing | Documentation inventory |
|