architext 0.0.4 → 0.0.6
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 +55 -1
- package/README.md +93 -14
- package/README.zh-CN.md +92 -14
- package/dist/index.js +53 -39
- package/dist/templates/en/briefs/_base.md +53 -13
- package/dist/templates/en/briefs/_modules.md +31 -4
- package/dist/templates/en/docs/global/error_memory.json +40 -0
- package/dist/templates/en/docs/global/map.json +46 -90
- package/dist/templates/en/{rules/04_cli_tools.md → docs/global/references/cli_reference.md} +6 -13
- package/dist/templates/en/{rules/02_tech_stack.md → docs/global/tech_stack.md} +7 -18
- package/dist/templates/en/docs/global/vision.md +1 -1
- package/dist/templates/en/docs/prompts/audit.md +80 -94
- package/dist/templates/en/docs/prompts/code.md +99 -89
- package/dist/templates/en/docs/prompts/edit.md +61 -51
- package/dist/templates/en/docs/prompts/fix.md +59 -43
- package/dist/templates/en/docs/prompts/help.md +23 -31
- package/dist/templates/en/docs/prompts/inherit.md +97 -117
- package/dist/templates/en/docs/prompts/map.md +48 -69
- package/dist/templates/en/docs/prompts/plan.md +141 -240
- package/dist/templates/en/docs/prompts/recover.md +19 -34
- package/dist/templates/en/docs/prompts/ref.md +43 -138
- package/dist/templates/en/docs/prompts/remove.md +63 -110
- package/dist/templates/en/docs/prompts/revise.md +71 -106
- package/dist/templates/en/docs/prompts/scope.md +78 -117
- package/dist/templates/en/docs/prompts/script.md +102 -0
- package/dist/templates/en/docs/prompts/start.md +98 -132
- package/dist/templates/en/docs/prompts/ui.md +113 -0
- package/dist/templates/en/docs/shared/ui-redlines.md +7 -0
- package/dist/templates/en/docs/templates/spec.template.md +1 -1
- package/dist/templates/en/docs/templates/ui.template.md +8 -8
- package/dist/templates/en/rules/00_system.md +268 -117
- package/dist/templates/en/rules/90_custom_rules.md +3 -1
- package/dist/templates/en/skills/archi-data-sync/SKILL.md +37 -23
- package/dist/templates/en/skills/archi-decompose-roadmap/SKILL.md +138 -240
- package/dist/templates/en/skills/archi-design-patterns/SKILL.md +6 -1
- package/dist/templates/en/skills/archi-feature-relations/SKILL.md +10 -6
- package/dist/templates/en/skills/archi-interview-protocol/SKILL.md +2 -2
- package/dist/templates/en/skills/archi-plan-options/SKILL.md +77 -301
- package/dist/templates/en/skills/archi-silent-audit/SKILL.md +24 -25
- package/dist/templates/en/skills/archi-ui-wireframe/SKILL.md +175 -305
- package/dist/templates/icon.svg +16 -0
- package/dist/templates/zh/briefs/_base.md +56 -17
- package/dist/templates/zh/briefs/_modules.md +28 -1
- package/dist/templates/zh/docs/global/error_memory.json +40 -0
- package/dist/templates/zh/docs/global/map.json +39 -109
- package/dist/templates/zh/{rules/04_cli_tools.md → docs/global/references/cli_reference.md} +0 -7
- package/dist/templates/zh/{rules/02_tech_stack.md → docs/global/tech_stack.md} +9 -20
- package/dist/templates/zh/docs/global/vision.md +1 -1
- package/dist/templates/zh/docs/prompts/audit.md +43 -57
- package/dist/templates/zh/docs/prompts/code.md +66 -56
- package/dist/templates/zh/docs/prompts/edit.md +52 -42
- package/dist/templates/zh/docs/prompts/fix.md +39 -29
- package/dist/templates/zh/docs/prompts/help.md +13 -21
- package/dist/templates/zh/docs/prompts/inherit.md +67 -86
- package/dist/templates/zh/docs/prompts/map.md +28 -50
- package/dist/templates/zh/docs/prompts/plan.md +100 -199
- package/dist/templates/zh/docs/prompts/recover.md +9 -24
- package/dist/templates/zh/docs/prompts/ref.md +11 -106
- package/dist/templates/zh/docs/prompts/remove.md +39 -74
- package/dist/templates/zh/docs/prompts/revise.md +47 -88
- package/dist/templates/zh/docs/prompts/scope.md +52 -91
- package/dist/templates/zh/docs/prompts/script.md +102 -0
- package/dist/templates/zh/docs/prompts/start.md +75 -110
- package/dist/templates/zh/docs/prompts/ui.md +113 -0
- package/dist/templates/zh/docs/shared/ui-redlines.md +7 -0
- package/dist/templates/zh/docs/templates/spec.template.md +1 -1
- package/dist/templates/zh/docs/templates/ui.template.md +8 -8
- package/dist/templates/zh/rules/00_system.md +252 -131
- package/dist/templates/zh/rules/90_custom_rules.md +2 -1
- package/dist/templates/zh/skills/archi-data-sync/SKILL.md +27 -13
- package/dist/templates/zh/skills/archi-decompose-roadmap/SKILL.md +133 -235
- package/dist/templates/zh/skills/archi-design-patterns/SKILL.md +6 -1
- package/dist/templates/zh/skills/archi-feature-relations/SKILL.md +6 -2
- package/dist/templates/zh/skills/archi-interview-protocol/SKILL.md +2 -2
- package/dist/templates/zh/skills/archi-plan-options/SKILL.md +77 -301
- package/dist/templates/zh/skills/archi-silent-audit/SKILL.md +4 -5
- package/dist/templates/zh/skills/archi-ui-wireframe/SKILL.md +174 -301
- package/package.json +3 -1
- package/dist/templates/en/rules/01_workflow.md +0 -93
- package/dist/templates/en/rules/03_data_governance.md +0 -102
- package/dist/templates/en/rules/99_context_glue.md +0 -53
- package/dist/templates/zh/rules/01_workflow.md +0 -94
- package/dist/templates/zh/rules/03_data_governance.md +0 -133
- package/dist/templates/zh/rules/99_context_glue.md +0 -53
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
## Project Overview
|
|
8
8
|
|
|
9
|
-
**Project Name**:
|
|
9
|
+
**Project Name**:
|
|
10
10
|
**One-line description**: [What the project is, who it serves, what problem it solves]
|
|
11
11
|
**Problem statement**: [Core pain points for target users? Where do existing solutions fall short?]
|
|
12
12
|
|
|
@@ -18,14 +18,29 @@
|
|
|
18
18
|
|
|
19
19
|
---
|
|
20
20
|
|
|
21
|
-
##
|
|
21
|
+
## Functional Requirements
|
|
22
22
|
|
|
23
|
-
>
|
|
24
|
-
>
|
|
23
|
+
> Core capabilities to implement—describe "what" not "how."
|
|
24
|
+
> AI will decompose these into implementation tasks; here just clarify the business goal.
|
|
25
25
|
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
26
|
+
-
|
|
27
|
+
-
|
|
28
|
+
-
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## Business Process
|
|
33
|
+
|
|
34
|
+
> If your project has clear user journeys or core workflows, describe them here.
|
|
35
|
+
> No need for diagrams—describe steps in text; AI will infer system behavior from this.
|
|
36
|
+
> Leave blank if not applicable; AI will derive from core tasks.
|
|
37
|
+
|
|
38
|
+
<!-- Format reference:
|
|
39
|
+
### [Process name]
|
|
40
|
+
1. User [action] → System [response]
|
|
41
|
+
2. User [action] → System [response]
|
|
42
|
+
3. ...
|
|
43
|
+
-->
|
|
29
44
|
|
|
30
45
|
---
|
|
31
46
|
|
|
@@ -36,7 +51,7 @@
|
|
|
36
51
|
>
|
|
37
52
|
> Format:
|
|
38
53
|
> - **[Task/page name]**: Describe behavior, flow, constraints
|
|
39
|
-
> - May include screenshot/sketch
|
|
54
|
+
> - May include screenshot/sketch (see "Design Assets" below)
|
|
40
55
|
|
|
41
56
|
---
|
|
42
57
|
|
|
@@ -45,7 +60,7 @@
|
|
|
45
60
|
> Fill in what's confirmed. Leave blank or write "recommend" for the rest; AI will recommend based on project characteristics.
|
|
46
61
|
|
|
47
62
|
**Project type**: [[__PROJECT_TYPE__]]
|
|
48
|
-
<!-- Auto-filled by archi init; if writing manually,
|
|
63
|
+
<!-- Auto-filled by archi init; if writing manually, choose from ui/data/api/cli/lib/mobile/desktop/miniapp/extension/realtime/ai -->
|
|
49
64
|
**Language/runtime**: [e.g.: TypeScript + Node.js 22]
|
|
50
65
|
**Core framework**: [e.g.: Next.js 15 / Fastify / Tauri]
|
|
51
66
|
**Package manager**: [e.g.: pnpm / npm / yarn / cargo]
|
|
@@ -69,6 +84,13 @@
|
|
|
69
84
|
**Directory structure**: [already defined → describe key dirs / none (AI generates based on pattern)]
|
|
70
85
|
**Branching strategy**: [e.g.: Trunk-based / Git Flow / GitHub Flow]
|
|
71
86
|
**Commit convention**: [e.g.: Conventional Commits (feat/fix/chore) / custom → describe]
|
|
87
|
+
|
|
88
|
+
**AI Git Workflow** (Git conventions when AI runs `/archi.code`):
|
|
89
|
+
- **Auto commit**: [Yes - auto git commit after each Task / No - generate commit message only, user commits manually]
|
|
90
|
+
- **Commit granularity**: [Per Task / Per Phase / As needed]
|
|
91
|
+
- **Branching**: [Work directly on main / Create branch per Task `feat/{task-id}`]
|
|
92
|
+
- **Auto push**: [Yes / No]
|
|
93
|
+
|
|
72
94
|
**Testing preference**: [e.g.: Vitest / Jest / pytest / no special requirements]
|
|
73
95
|
|
|
74
96
|
---
|
|
@@ -78,14 +100,33 @@
|
|
|
78
100
|
> What already exists that AI should know—to avoid reinventing or making conflicting decisions.
|
|
79
101
|
|
|
80
102
|
**Project starting point**: [Greenfield / based on existing repo (brief status and tech debt)]
|
|
81
|
-
**Design assets**: [Figma link / design mockup screenshots / none (AI designs)]
|
|
82
|
-
**Brand guidelines**: [Existing logo/colors/fonts → describe or link / none]
|
|
83
103
|
**Existing API/backend**: [API docs link / brief available endpoints / none (build from scratch)]
|
|
84
104
|
**Third-party services**: [Confirmed services, e.g.: Auth0, Stripe, AWS S3, Resend...]
|
|
85
105
|
**Existing data**: [Existing DB/data sources? Format? Migration needed? / none]
|
|
86
106
|
|
|
87
107
|
---
|
|
88
108
|
|
|
109
|
+
## Design Assets
|
|
110
|
+
|
|
111
|
+
> Provide visual/design input for AI—directly impacts UI and architecture decision quality.
|
|
112
|
+
> Two ways to provide files:
|
|
113
|
+
> 1. **Local files**: Place files in `brief-assets/` directory, reference by format below
|
|
114
|
+
> 2. **External links**: Paste URL directly
|
|
115
|
+
>
|
|
116
|
+
> Reference format: `- [semantic label] ./brief-assets/filename`
|
|
117
|
+
>
|
|
118
|
+
> Format reference:
|
|
119
|
+
> - [Competitor reference - home] ./brief-assets/linear-dashboard.png
|
|
120
|
+
> - [My sketch] ./brief-assets/sketch-v1.png
|
|
121
|
+
> - [Brand palette] ./brief-assets/brand-colors.pdf
|
|
122
|
+
> - [API docs] ./brief-assets/api-spec.yaml
|
|
123
|
+
> - [Database Schema] ./brief-assets/schema.sql
|
|
124
|
+
|
|
125
|
+
**Design mockups/screenshots**: [Reference local files per format above / Figma link / none (AI designs)]
|
|
126
|
+
**Brand guidelines**: [Existing logo/colors/fonts → reference file or describe / none]
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
89
130
|
<!-- @slot:style -->
|
|
90
131
|
|
|
91
132
|
## Scope & Constraints
|
|
@@ -94,7 +135,6 @@
|
|
|
94
135
|
- [e.g.: No i18n this release / no mobile adaption / no paid features]
|
|
95
136
|
|
|
96
137
|
**Hard constraints**:
|
|
97
|
-
- **Timeline**: [e.g.: 4-week MVP / no hard deadline]
|
|
98
138
|
- **Compatibility**: [e.g.: Chrome 90+ / Node 18+ / iOS 15+]
|
|
99
139
|
- **Performance**: [e.g.: First paint < 2s / API P99 < 500ms / no special requirements]
|
|
100
140
|
- **Compliance/accessibility**: [e.g.: WCAG 2.1 AA / GDPR / none]
|
|
@@ -112,4 +152,4 @@
|
|
|
112
152
|
|
|
113
153
|
## Additional Notes
|
|
114
154
|
|
|
115
|
-
> Anything not covered above: background story, special requirements, rationale for decisions,
|
|
155
|
+
> Anything not covered above: background story, special requirements, rationale for decisions, etc.
|
|
@@ -5,10 +5,37 @@
|
|
|
5
5
|
<!-- @tech:data -->
|
|
6
6
|
**Database**: [e.g.: PostgreSQL / MongoDB / SQLite]
|
|
7
7
|
**ORM / Query Builder**: [e.g.: Prisma / Drizzle / TypeORM]
|
|
8
|
+
|
|
9
|
+
### Data Model Draft
|
|
10
|
+
|
|
11
|
+
> If you already know core data entities and relationships, describe them here. No need for full schema—list entity names and key fields.
|
|
12
|
+
> AI will generate detailed data model in `/archi.plan`; here just clarify "what data exists."
|
|
13
|
+
> Leave blank if not applicable; AI will derive from core features.
|
|
14
|
+
|
|
15
|
+
<!-- Format reference:
|
|
16
|
+
- **User**: email, name, role (admin/user), avatar
|
|
17
|
+
- **Post**: title, content, status (draft/published), author → User
|
|
18
|
+
- **Comment**: body, author → User, post → Post
|
|
19
|
+
- User 1:N Post, Post 1:N Comment
|
|
20
|
+
-->
|
|
21
|
+
|
|
8
22
|
<!-- @end -->
|
|
9
23
|
|
|
10
24
|
<!-- @tech:api -->
|
|
11
25
|
**API style**: [e.g.: RESTful / GraphQL / gRPC / tRPC]
|
|
26
|
+
|
|
27
|
+
### Existing API Endpoints
|
|
28
|
+
|
|
29
|
+
> If you have existing backend API (self-hosted or third-party), list core endpoints here. Or place full docs in `brief-assets/`.
|
|
30
|
+
> Leave blank if not applicable.
|
|
31
|
+
|
|
32
|
+
<!-- Format reference:
|
|
33
|
+
- `POST /auth/login` → returns JWT token
|
|
34
|
+
- `GET /users/:id` → user detail
|
|
35
|
+
- `POST /posts` → create post (auth required)
|
|
36
|
+
- Full docs: [API docs] ./brief-assets/api-spec.yaml
|
|
37
|
+
-->
|
|
38
|
+
|
|
12
39
|
<!-- @end -->
|
|
13
40
|
|
|
14
41
|
<!-- @tech:cli -->
|
|
@@ -44,8 +71,8 @@
|
|
|
44
71
|
|
|
45
72
|
### Visual Reference
|
|
46
73
|
|
|
47
|
-
> Provides aesthetic input for AI
|
|
48
|
-
>
|
|
74
|
+
> Provides aesthetic input for AI—directly impacts visual quality of screen prototypes in the `screens/` directory.
|
|
75
|
+
> Any field below is valid; the more you fill, the better AI can match your expected style.
|
|
49
76
|
|
|
50
77
|
**Competitor/inspiration screenshots**: [paste image / Figma link / URL]
|
|
51
78
|
**Brand palette**: [primary color Hex / gradient description / none (AI generates from aesthetic direction)]
|
|
@@ -116,7 +143,7 @@
|
|
|
116
143
|
**Real-time transport**: [e.g.: Socket.io / native WebSocket / SSE / WebRTC]
|
|
117
144
|
**Real-time framework/hosting**: [e.g.: Ably / Pusher / Liveblocks / self-hosted]
|
|
118
145
|
**Room/channel model**: [e.g.: subscribe by user ID / room by document ID / broadcast]
|
|
119
|
-
**
|
|
146
|
+
**(CRDT projects only) Conflict resolution**: [e.g.: Yjs / Automerge / not needed (broadcast only)]
|
|
120
147
|
**Offline support**: [e.g.: offline queue + reconnect sync / not needed]
|
|
121
148
|
<!-- @end -->
|
|
122
149
|
|
|
@@ -125,7 +152,7 @@
|
|
|
125
152
|
**AI framework**: [e.g.: Vercel AI SDK / LangChain / LlamaIndex / direct API calls]
|
|
126
153
|
**Tool/Function Calling**: [e.g.: needed (list tool names) / not needed]
|
|
127
154
|
**Memory approach**: [e.g.: vector DB (pgvector/Pinecone) / sliding window history / none]
|
|
128
|
-
**
|
|
155
|
+
**(MCP projects only) MCP protocol**: [e.g.: @modelcontextprotocol/sdk / not needed]
|
|
129
156
|
**Streaming output**: [e.g.: SSE streaming / batch response]
|
|
130
157
|
<!-- @end -->
|
|
131
158
|
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
{
|
|
2
|
+
"errorPatterns": {
|
|
3
|
+
"_comment": "Error patterns: { id: unique identifier, watchFor: [scenarios to watch before execution], matchWhen: [keywords to match after error], cause: root cause, solution: solution, lesson: lesson/principle }. AI appends here after resolving errors",
|
|
4
|
+
"examples": [
|
|
5
|
+
{
|
|
6
|
+
"id": "build-vite-config-missing",
|
|
7
|
+
"watchFor": ["Run npm run build", "Modify vite.config.ts"],
|
|
8
|
+
"matchWhen": ["ENOENT", "vite.config", "Cannot find module"],
|
|
9
|
+
"cause": "Config file deleted or node_modules not installed",
|
|
10
|
+
"solution": "Check file existence, run npm install to reinstall deps",
|
|
11
|
+
"lesson": "Backup before modifying configs, regularly verify node_modules integrity"
|
|
12
|
+
},
|
|
13
|
+
{
|
|
14
|
+
"id": "type-import-assertion-deprecated",
|
|
15
|
+
"watchFor": ["Import JSON files"],
|
|
16
|
+
"matchWhen": ["assert", "SyntaxError", "import", "type"],
|
|
17
|
+
"cause": "Node.js 18+ deprecated import assert syntax, use import attributes instead",
|
|
18
|
+
"solution": "Change assert { type: 'json' } to with { type: 'json' }",
|
|
19
|
+
"lesson": "Watch Node.js version updates, verify import JSON syntax for your version"
|
|
20
|
+
}
|
|
21
|
+
]
|
|
22
|
+
},
|
|
23
|
+
"checkpoints": {
|
|
24
|
+
"_comment": "Checkpoints: { before: operation description to match before execution, check: [list of errorPatterns.id to check] }. AI auto-generates from watchFor scenarios",
|
|
25
|
+
"examples": [
|
|
26
|
+
{
|
|
27
|
+
"before": "Run npm run build",
|
|
28
|
+
"check": ["build-vite-config-missing"]
|
|
29
|
+
},
|
|
30
|
+
{
|
|
31
|
+
"before": "Modify config files",
|
|
32
|
+
"check": ["build-vite-config-missing"]
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
"before": "Import JSON files",
|
|
36
|
+
"check": ["type-import-assertion-deprecated"]
|
|
37
|
+
}
|
|
38
|
+
]
|
|
39
|
+
}
|
|
40
|
+
}
|
|
@@ -1,99 +1,55 @@
|
|
|
1
1
|
{
|
|
2
|
-
"
|
|
3
|
-
"
|
|
2
|
+
"directoryMapping": {
|
|
3
|
+
"_comment": "Code directory ↔ module mapping: { path: directory path, module: module name, responsibility: responsibility description }",
|
|
4
|
+
"examples": [
|
|
4
5
|
{
|
|
5
|
-
"
|
|
6
|
-
"
|
|
7
|
-
"
|
|
6
|
+
"path": "src/features/auth",
|
|
7
|
+
"module": "auth",
|
|
8
|
+
"responsibility": "User authentication, login, registration"
|
|
8
9
|
},
|
|
9
10
|
{
|
|
10
|
-
"
|
|
11
|
-
"
|
|
12
|
-
"
|
|
13
|
-
},
|
|
14
|
-
{
|
|
15
|
-
"file": "02_tech_stack.md",
|
|
16
|
-
"role": "Tech Stack",
|
|
17
|
-
"when": "Tech choices, coding standards, engineering governance"
|
|
18
|
-
},
|
|
19
|
-
{
|
|
20
|
-
"file": "03_data_governance.md",
|
|
21
|
-
"role": "Data Governance",
|
|
22
|
-
"when": "When reading/writing global JSON data files"
|
|
23
|
-
},
|
|
24
|
-
{
|
|
25
|
-
"file": "04_cli_tools.md",
|
|
26
|
-
"role": "CLI Reference",
|
|
27
|
-
"when": "When executing Terminal Gate commands (npx archi task/plan/render syntax reference)"
|
|
28
|
-
},
|
|
29
|
-
{
|
|
30
|
-
"file": "99_context_glue.md",
|
|
31
|
-
"role": "Context Bridge",
|
|
32
|
-
"when": "Automatically links context docs when touching code"
|
|
11
|
+
"path": "src/features/todos",
|
|
12
|
+
"module": "todo",
|
|
13
|
+
"responsibility": "Todo CRUD operations"
|
|
33
14
|
}
|
|
34
|
-
]
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
}
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
{
|
|
47
|
-
"
|
|
48
|
-
"
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
{
|
|
57
|
-
"file": "design_tokens.json",
|
|
58
|
-
"role": "Visuals [?UI]",
|
|
59
|
-
"content": "Colors, typography, spacing variables"
|
|
60
|
-
},
|
|
61
|
-
{
|
|
62
|
-
"file": "data_snapshot.json",
|
|
63
|
-
"role": "Data [?Data]",
|
|
64
|
-
"content": "Database Schema snapshot"
|
|
65
|
-
},
|
|
66
|
-
{
|
|
67
|
-
"file": "error_codes.json",
|
|
68
|
-
"role": "Errors",
|
|
69
|
-
"content": "Error codes & protocol contracts"
|
|
15
|
+
]
|
|
16
|
+
},
|
|
17
|
+
"logicalTopology": {
|
|
18
|
+
"_comment": "Logical topology: { module: module name, layer: layer(layer/domain/interface/infrastructure), depends: [dependent modules] }",
|
|
19
|
+
"examples": [
|
|
20
|
+
{ "module": "auth", "layer": "domain", "depends": ["user-repo"] },
|
|
21
|
+
{ "module": "todo", "layer": "domain", "depends": ["auth", "todo-repo"] }
|
|
22
|
+
]
|
|
23
|
+
},
|
|
24
|
+
"criticalUserJourneys": {
|
|
25
|
+
"_comment": "Critical user journeys: { journey: journey name, steps: [steps], owner: owning task ID }",
|
|
26
|
+
"examples": [
|
|
27
|
+
{
|
|
28
|
+
"journey": "User Registration & Login",
|
|
29
|
+
"steps": [
|
|
30
|
+
"Visit homepage",
|
|
31
|
+
"Click register",
|
|
32
|
+
"Fill form",
|
|
33
|
+
"Submit",
|
|
34
|
+
"Login success"
|
|
35
|
+
],
|
|
36
|
+
"owner": "FEAT-AUTH"
|
|
70
37
|
}
|
|
71
38
|
]
|
|
72
39
|
},
|
|
73
|
-
"
|
|
74
|
-
{
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
},
|
|
89
|
-
{
|
|
90
|
-
"file": "plan.json",
|
|
91
|
-
"category": "Plan",
|
|
92
|
-
"purpose": "Detailed Step Breakdown & Test Cases (Execution)"
|
|
93
|
-
}
|
|
94
|
-
],
|
|
95
|
-
"directoryMapping": [],
|
|
96
|
-
"logicalTopology": [],
|
|
97
|
-
"criticalUserJourneys": [],
|
|
98
|
-
"featureRelations": []
|
|
40
|
+
"featureRelations": {
|
|
41
|
+
"_comment": "Impact relations organized as networks: { group: network name, members: [member files], rule: change rule }",
|
|
42
|
+
"examples": [
|
|
43
|
+
{
|
|
44
|
+
"group": "Tech Specs",
|
|
45
|
+
"members": [
|
|
46
|
+
"tech_stack.md",
|
|
47
|
+
"prompts/code.md",
|
|
48
|
+
"prompts/audit.md",
|
|
49
|
+
"rules/00_system.md"
|
|
50
|
+
],
|
|
51
|
+
"rule": "Tech stack changes need to sync protocol docs"
|
|
52
|
+
}
|
|
53
|
+
]
|
|
54
|
+
}
|
|
99
55
|
}
|
|
@@ -1,13 +1,6 @@
|
|
|
1
|
-
---
|
|
2
|
-
description: CLI Reference Manual. Working directory rule and command syntax for npx archi task/plan/render.
|
|
3
|
-
globs: **/*
|
|
4
|
-
applyTo: **/*
|
|
5
|
-
alwaysApply: true
|
|
6
|
-
---
|
|
7
|
-
|
|
8
1
|
# CLI Reference
|
|
9
2
|
|
|
10
|
-
> **Role**: Command
|
|
3
|
+
> **Role**: Command reference manual. Provides syntax and parameters for `npx archi` commands, for use during Terminal Gate execution.
|
|
11
4
|
|
|
12
5
|
## ⛔ Working Directory Gate
|
|
13
6
|
|
|
@@ -16,7 +9,7 @@ alwaysApply: true
|
|
|
16
9
|
| Check | Pass Condition |
|
|
17
10
|
|:---|:---|
|
|
18
11
|
| Current directory | Must be project root (directory containing `[[__DOCS_DIR__]]/`) |
|
|
19
|
-
|
|
|
12
|
+
| When uncertain | Confirm current directory first; do not guess |
|
|
20
13
|
| In subdirectory | Must `cd` to root before executing |
|
|
21
14
|
|
|
22
15
|
---
|
|
@@ -27,7 +20,7 @@ alwaysApply: true
|
|
|
27
20
|
|
|
28
21
|
| Subcommand | Purpose | Example |
|
|
29
22
|
|:---|:---|:---|
|
|
30
|
-
| `npx archi task` | List all tasks
|
|
23
|
+
| `npx archi task` | List all tasks and progress | `npx archi task` |
|
|
31
24
|
| `npx archi task <ID> --status <s>` | Update task status | `npx archi task INF-001 --status done` |
|
|
32
25
|
| `npx archi task --check` | Check Roadmap consistency | `npx archi task --check` |
|
|
33
26
|
|
|
@@ -37,7 +30,7 @@ alwaysApply: true
|
|
|
37
30
|
|
|
38
31
|
| Subcommand | Purpose | Example |
|
|
39
32
|
|:---|:---|:---|
|
|
40
|
-
| `npx archi plan <ID>` | Check Task
|
|
33
|
+
| `npx archi plan <ID>` | Check Task Plan completion | `npx archi plan SUB-01` |
|
|
41
34
|
|
|
42
35
|
Automatically identifies Manual Verification sections and excludes them from automated statistics.
|
|
43
36
|
|
|
@@ -45,6 +38,6 @@ Automatically identifies Manual Verification sections and excludes them from aut
|
|
|
45
38
|
|
|
46
39
|
| Subcommand | Purpose | Example |
|
|
47
40
|
|:---|:---|:---|
|
|
48
|
-
| `npx archi render` | Render all JSON data files
|
|
41
|
+
| `npx archi render` | Render all JSON data files as human-readable `.md` views | `npx archi render` |
|
|
49
42
|
|
|
50
|
-
> `.md` views are auto-generated;
|
|
43
|
+
> `.md` views are auto-generated; do not edit directly. Modifications must go through the `.json` source files.
|
|
@@ -1,10 +1,3 @@
|
|
|
1
|
-
---
|
|
2
|
-
description: Technical Standards & Technology Stack. Contains language versions, framework choices, coding conventions, naming rules, and forbidden patterns. Consult when writing code.
|
|
3
|
-
globs: **/*
|
|
4
|
-
applyTo: **/*
|
|
5
|
-
alwaysApply: true
|
|
6
|
-
---
|
|
7
|
-
|
|
8
1
|
# Tech Stack & Engineering Standards: [Project Name]
|
|
9
2
|
|
|
10
3
|
> **Role:** The "Law" of the codebase. Defines tools, structure, and engineering workflows.
|
|
@@ -53,23 +46,19 @@ alwaysApply: true
|
|
|
53
46
|
|
|
54
47
|
---
|
|
55
48
|
|
|
56
|
-
## 4. UI Protocol: ITP v3.0 (
|
|
49
|
+
## 4. UI Protocol: ITP v3.0 (Tri-Artifact) [Optional - Only for UI Projects]
|
|
57
50
|
<!-- Core UI Description Protocol -->
|
|
58
51
|
> **Note:** If project has no UI (e.g. CLI, Backend API, Library), remove this section.
|
|
59
52
|
|
|
60
|
-
### 4.1
|
|
61
|
-
|
|
62
|
-
UI artifact hierarchy:
|
|
53
|
+
### 4.1 Tri-Artifact Strategy
|
|
63
54
|
|
|
64
55
|
| Artifact | Format | Reader | Responsibility |
|
|
65
56
|
|:---|:---|:---|:---|
|
|
66
|
-
| `
|
|
67
|
-
| `ui_context.md` | Structured Markdown | AI (plan/code/audit/edit) | **AI screen index** —
|
|
68
|
-
| `ui.md` | ITP v3.0 DSL | AI (code/audit) | Task-level UI scope declaration — which screens/
|
|
69
|
-
|
|
70
|
-
- `
|
|
71
|
-
- `ui.md` only declares "which screens/states in ui_context.md this task is responsible for"; do not redefine global layout
|
|
72
|
-
- Code phase uses `ui.md` (task design) + `ui_context.md` (structure/navigation) + `design_tokens.json` (visual constraints) as source; also uses `ui_concept.html` as **read-only visual reference** to calibrate layout; implement equivalent visual effect with the **project's own tech stack**
|
|
57
|
+
| `screens/` | Multi-file HTML (`index.html` + `S-XX.html` + `_shared.css`) | Human (browser) | **Global visual source of truth** — triggered by `/archi.ui` Skill; each screen independently previewable |
|
|
58
|
+
| `ui_context.md` | Structured Markdown | AI (plan/code/audit/edit) | **AI screen index** — sole AI entry point for UI structure; generated by same Skill; do not edit manually |
|
|
59
|
+
| `ui.md` | ITP v3.0 DSL | AI (code/audit) | Task-level UI scope declaration — only declares which screens/states this task covers; do not redefine global layout |
|
|
60
|
+
|
|
61
|
+
- Code phase uses `ui.md` + `ui_context.md` + `design_tokens.json` as source; `screens/S-XX.html` as **read-only visual reference**; implement equivalent visual effect with **project's own tech stack**
|
|
73
62
|
|
|
74
63
|
### 4.2 Naming (PrefixFunction)
|
|
75
64
|
Component naming must follow `Prefix+Function` format:
|
|
@@ -77,6 +77,6 @@ description: Project Constitution: Vision, Personas, Principles & Boundaries.
|
|
|
77
77
|
**Trigger**: Only modify during project initialization (`/archi.start`) or major strategic pivot (`/archi.revise`).
|
|
78
78
|
|
|
79
79
|
**Action**:
|
|
80
|
-
1. **Alignment**: Ensure Section 3 (Principles) conflicts with technology choices in `
|
|
80
|
+
1. **Alignment**: Ensure Section 3 (Principles) conflicts with technology choices in `tech_stack.md`.
|
|
81
81
|
2. **Completeness**: Must fill all `[ ]` placeholders, strictly no "Example" text remaining.
|
|
82
82
|
3. **Consistency**: All Task Specs (`.spec.md`) must reference the Vision in this file to ensure alignment.
|