astragentic 1.0.0 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -6,8 +6,17 @@ This is the installer for the Astragentic DevKit. It sets up the necessary confi
6
6
 
7
7
  Run the following command in your project root:
8
8
 
9
+ ### Default (Latest)
9
10
  ```bash
10
11
  npx astragentic install
12
+ # OR explicitly:
13
+ npx astragentic@latest install
14
+ ```
15
+
16
+ ### Specific Version
17
+ If you need to install a specific version (e.g., to downgrade or ensure consistency):
18
+ ```bash
19
+ npx astragentic@1.0.0 install
11
20
  ```
12
21
 
13
22
  This command will:
@@ -144,19 +144,17 @@ Validate complete understanding before generation:
144
144
 
145
145
  ### Atlas Folder Structure
146
146
 
147
+ **Reading Order:** Files are numbered 1→5 for sequential reading.
148
+
147
149
  ```
148
150
  .astraler-docs/
149
151
  ├── _index.md
150
- ├── atlas/
151
- │ ├── index.md # Vision, tech stack, ALL domains
152
- │ ├── database.md # Complete schema, ALL entities
153
- │ ├── screens.md # ALL screens, ALL domains
154
- │ ├── api.md # ALL endpoints, ALL domains
155
- │ └── tasks.md # ALL tasks, ALL domains
156
- ├── context/
157
- │ ├── constraints.md
158
- │ ├── assumptions.md
159
- │ └── glossary.md
152
+ ├── atlas/ # PRIMARY - read in order 1→5
153
+ │ ├── 1-overview.md # High-level vision, goals, domains (start here)
154
+ │ ├── 2-context.md # Constraints, assumptions, glossary
155
+ │ ├── 3-database.md # Complete schema, ALL entities
156
+ │ ├── 4-screens.md # UI inventory (if UI exists)
157
+ │ └── 5-api.md # API surface inventory (not detailed contracts)
160
158
  ├── changes/
161
159
  │ ├── changelog.md
162
160
  │ └── impact/
@@ -167,39 +165,43 @@ Validate complete understanding before generation:
167
165
 
168
166
  ### Atlas File Specifications
169
167
 
170
- #### `atlas/index.md`
171
- - Project vision and success metrics
172
- - Complete tech stack table
173
- - ALL domains with purpose and priority
174
- - Domain relationship diagram (Mermaid)
168
+ #### `1-overview.md` — High-Level Overview (Start Here)
169
+ - Project vision (1-2 sentences)
170
+ - Success metrics (table)
171
+ - Tech stack summary (table)
172
+ - ALL domains listed with purpose and priority
173
+ - Domain relationship diagram (Mermaid flowchart)
175
174
  - Project structure (folder tree)
176
- - External integrations
177
175
 
178
- #### `atlas/database.md`
179
- - Complete ERD (Mermaid) showing ALL entities
176
+ **Simplicity:** Keep high-level; detailed domain specs go in `domains/` if needed.
177
+
178
+ #### `2-context.md` — Background & Constraints
179
+ - Key constraints (technical, business, timeline)
180
+ - Assumptions and risks
181
+ - Glossary of domain terms
182
+
183
+ **Simplicity:** Consolidates what was previously a separate `context/` folder.
184
+
185
+ #### `3-database.md` — Data Model
186
+ - Complete ERD (Mermaid erDiagram)
180
187
  - ALL tables with columns, types, constraints
181
188
  - ALL relationships and foreign keys
182
- - ALL indexes
183
- - Cross-domain references
184
- - Migration strategy
185
-
186
- #### `atlas/screens.md`
187
- - Navigation map (Mermaid) showing ALL screens
188
- - ALL screens table (route, domain, auth)
189
- - Screen details for each (purpose, components, actions, API calls)
190
-
191
- #### `atlas/api.md`
192
- - Base URL and authentication
193
- - ALL endpoints summary table
194
- - Endpoint details for each (request, response, errors)
195
- - Webhooks (if applicable)
196
- - Rate limiting
197
-
198
- #### `atlas/tasks.md`
199
- - Milestone overview (Mermaid gantt)
200
- - Task dependency graph (Mermaid flowchart)
201
- - ALL tasks with ID, domain, dependencies, acceptance criteria
202
- - Definition of Done
189
+ - Migration strategy (if applicable)
190
+
191
+ #### `4-screens.md` UI Inventory (If UI Exists)
192
+ - Navigation map (Mermaid flowchart)
193
+ - ALL screens table (route, domain, auth requirement)
194
+ - Brief screen purpose (1 line each)
195
+
196
+ **Simplicity:** No detailed component breakdowns; just inventory.
197
+
198
+ #### `5-api.md` — API Surface Inventory
199
+ - Base URL and authentication method
200
+ - ALL endpoints summary table (method, route, domain, auth)
201
+ - Estimated endpoint count per domain
202
+ - External integrations (Stripe, SendGrid, etc.)
203
+
204
+ **Simplicity:** Sketch the API surface only. No request/response schemas yet — those come during `/astra:plan` or implementation.
203
205
 
204
206
  ---
205
207
 
@@ -210,17 +212,17 @@ After Atlas generation, present for review:
210
212
  ```markdown
211
213
  ## Atlas Complete
212
214
 
213
- ### Generated Files
214
- - `atlas/index.md` — {X} domains, tech stack defined
215
- - `atlas/database.md` — {Y} tables, {Z} relationships
216
- - `atlas/screens.md` — {W} screens across all domains
217
- - `atlas/api.md` — {V} endpoints across all domains
218
- - `atlas/tasks.md` — {U} tasks in {T} phases
215
+ ### Generated Files (read in order 1→5)
216
+ - `atlas/1-overview.md` — {X} domains, tech stack, vision
217
+ - `atlas/2-context.md` — constraints, assumptions, glossary
218
+ - `atlas/3-database.md` — {Y} tables, {Z} relationships
219
+ - `atlas/4-screens.md` — {W} screens across all domains
220
+ - `atlas/5-api.md` — ~{V} endpoints (surface inventory)
219
221
 
220
222
  ### Domains Covered
221
- | Domain | Entities | Screens | Endpoints | Tasks |
222
- |--------|----------|---------|-----------|-------|
223
- | {domain} | {count} | {count} | {count} | {count} |
223
+ | Domain | Priority | Entities | Screens | Endpoints |
224
+ |--------|----------|----------|---------|-----------|
225
+ | {domain} | P0/P1 | {count} | {count} | ~{count} |
224
226
  {ALL domains listed}
225
227
 
226
228
  ### Ready to Expand
@@ -247,36 +249,35 @@ Upon approval, will auto-generate:
247
249
 
248
250
  | Atlas Source | Generates |
249
251
  |--------------|-----------|
250
- | `atlas/index.md` | `02-spec/core/overview.md` |
251
- | `atlas/index.md` | `03-arch/overview.md` |
252
- | `atlas/index.md` (domains) | `02-spec/domains/{domain}.md` (overview section) |
253
- | `atlas/database.md` | `03-arch/data-schema.md` |
254
- | `atlas/database.md` (per domain) | `03-arch/domains/{domain}.arch.md` (data models) |
255
- | `atlas/screens.md` (per domain) | `02-spec/domains/{domain}.md` (screens section) |
256
- | `atlas/api.md` (cross-domain) | `02-spec/core/flows.md` |
257
- | `atlas/api.md` (per domain) | `02-spec/domains/{domain}.md` (API section) |
258
- | `atlas/api.md` (per domain) | `03-arch/domains/{domain}.arch.md` (contracts) |
259
- | `atlas/tasks.md` (milestones) | `04-tasks/milestones.md` |
260
- | `atlas/tasks.md` (per domain) | `04-tasks/domains/{domain}.tasks.md` |
252
+ | `atlas/1-overview.md` | `02-spec/core/overview.md` |
253
+ | `atlas/1-overview.md` | `03-arch/overview.md` |
254
+ | `atlas/1-overview.md` (domains) | `02-spec/domains/{domain}.md` (overview section) |
255
+ | `atlas/2-context.md` | Constraints/assumptions embedded in specs |
256
+ | `atlas/3-database.md` | `03-arch/data-schema.md` |
257
+ | `atlas/3-database.md` (per domain) | `03-arch/domains/{domain}.arch.md` (data models) |
258
+ | `atlas/4-screens.md` (per domain) | `02-spec/domains/{domain}.md` (screens section) |
259
+ | `atlas/5-api.md` (cross-domain) | `02-spec/core/flows.md` |
260
+ | `atlas/5-api.md` (per domain) | `02-spec/domains/{domain}.md` (API section) |
261
+ | `atlas/5-api.md` (per domain) | `03-arch/domains/{domain}.arch.md` (contracts) |
261
262
 
262
263
  ### Generated Structure
263
264
 
264
265
  ```
265
266
  .astraler-docs/
266
267
  ├── _index.md
267
- ├── atlas/ # SOURCE (human-approved)
268
- │ ├── index.md
269
- │ ├── database.md
270
- │ ├── screens.md
271
- │ ├── api.md
272
- │ └── tasks.md
268
+ ├── atlas/ # SOURCE (human-approved, read 1→5)
269
+ │ ├── 1-overview.md
270
+ │ ├── 2-context.md
271
+ │ ├── 3-database.md
272
+ │ ├── 4-screens.md
273
+ │ └── 5-api.md
273
274
 
274
275
  ├── 02-spec/ # AUTO-GENERATED from Atlas
275
276
  │ ├── _index.md
276
277
  │ ├── core/
277
- │ │ ├── overview.md # ← from atlas/index.md
278
- │ │ ├── flows.md # ← from atlas/api.md (cross-domain)
279
- │ │ └── rules.md # ← from atlas/api.md (validation)
278
+ │ │ ├── overview.md # ← from atlas/1-overview.md
279
+ │ │ ├── flows.md # ← from atlas/5-api.md (cross-domain)
280
+ │ │ └── rules.md # ← from atlas/5-api.md (validation)
280
281
  │ └── domains/
281
282
  │ ├── auth.md # ← from atlas (auth sections)
282
283
  │ ├── catalog.md # ← from atlas (catalog sections)
@@ -285,8 +286,8 @@ Upon approval, will auto-generate:
285
286
 
286
287
  ├── 03-arch/ # AUTO-GENERATED from Atlas
287
288
  │ ├── _index.md
288
- │ ├── overview.md # ← from atlas/index.md
289
- │ ├── data-schema.md # ← from atlas/database.md
289
+ │ ├── overview.md # ← from atlas/1-overview.md
290
+ │ ├── data-schema.md # ← from atlas/3-database.md
290
291
  │ ├── standards.md # ← generated (DoD, conventions)
291
292
  │ ├── decisions.md # ← generated (ADR template)
292
293
  │ └── domains/
@@ -295,25 +296,11 @@ Upon approval, will auto-generate:
295
296
  │ ├── order.arch.md # ← from atlas (order sections)
296
297
  │ └── ... # One per domain
297
298
 
298
- ├── 04-tasks/ # AUTO-GENERATED from Atlas
299
- │ ├── _index.md
300
- │ ├── milestones.md # ← from atlas/tasks.md
301
- │ └── domains/
302
- │ ├── auth.tasks.md # ← from atlas/tasks.md (auth)
303
- │ ├── catalog.tasks.md # ← from atlas/tasks.md (catalog)
304
- │ ├── order.tasks.md # ← from atlas/tasks.md (order)
305
- │ └── ... # One per domain
306
-
307
299
  ├── 05-changes/
308
300
  │ ├── _index.md
309
301
  │ ├── changelog.md
310
302
  │ └── impact/
311
303
 
312
- ├── context/
313
- │ ├── constraints.md
314
- │ ├── assumptions.md
315
- │ └── glossary.md
316
-
317
304
  └── ai/
318
305
  ├── guardrails.md
319
306
  └── quality_gates.md
@@ -400,16 +387,15 @@ After expansion:
400
387
  - [ ] Tech stack decided
401
388
  - [ ] Cognitive Sync confirmed
402
389
 
403
- ### Atlas Files Complete
404
- - [ ] `atlas/index.md` — All domains, tech stack
405
- - [ ] `atlas/database.md` — All entities, relationships
406
- - [ ] `atlas/screens.md` — All screens, navigation
407
- - [ ] `atlas/api.md` — All endpoints, contracts
408
- - [ ] `atlas/tasks.md` — All tasks, dependencies
390
+ ### Atlas Files Complete (read in order)
391
+ - [ ] `atlas/1-overview.md` — Vision, domains, tech stack
392
+ - [ ] `atlas/2-context.md` — Constraints, assumptions, glossary
393
+ - [ ] `atlas/3-database.md` — All entities, relationships
394
+ - [ ] `atlas/4-screens.md` — All screens, navigation
395
+ - [ ] `atlas/5-api.md` — API surface inventory (~count per domain)
409
396
 
410
397
  ### After Expansion
411
398
  - [ ] `02-spec/` — Core + all domain specs
412
399
  - [ ] `03-arch/` — Overview + all domain arch
413
- - [ ] `04-tasks/` — Milestones + all domain tasks
414
400
  - [ ] All files have proper headers
415
401
  - [ ] All files have required diagrams
@@ -10,128 +10,55 @@ This file provides guidance to Claude Code when working with this repository.
10
10
 
11
11
  ---
12
12
 
13
- ## Framework Architecture
13
+ ## Start Here
14
14
 
15
- Astragentic operates through three interconnected roots:
15
+ **New to this project? Read the Atlas first:**
16
16
 
17
- | Root | Location | Purpose |
18
- |------|----------|---------|
19
- | **Artifacts** | `.astraler-docs/` | Source of truth for all design documents |
20
- | **Commands** | `.claude/commands/astra/` | AI command definitions (slash commands) |
21
- | **Engine** | `_astraler/` | Execution rules, workflows, and governance |
17
+ [`.astraler-docs/atlas/index.md`](.astraler-docs/atlas/index.md)
22
18
 
23
- ```
24
- your-project/
25
- ├── .astraler-docs/ # What we're building (artifacts)
26
- │ ├── 01-context/ # Vision, constraints, glossary
27
- │ ├── 02-spec/ # Business requirements by domain
28
- │ ├── 03-arch/ # Technical architecture by domain
29
- │ ├── 04-tasks/ # Implementation breakdown
30
- │ ├── 05-changes/ # Change records (CHG)
31
- │ └── ai/ # Rules, guardrails, quality gates
32
-
33
- ├── .claude/ # AI operating system
34
- │ └── commands/astra/ # Slash command definitions
35
-
36
- └── _astraler/ # Framework engine
37
- ├── engine.md # Core execution rules
38
- └── workflows/ # greenfield, brownfield, change
39
- ```
19
+ The Atlas contains the complete project blueprint: vision, tech stack, database schema, screens, API contracts, and implementation tasks.
40
20
 
41
21
  ---
42
22
 
43
- ## Project Documentation
44
-
45
- All project documentation lives in `.astraler-docs/`. Read these before making changes:
46
-
47
- ### Context & Vision
48
- - [Product Vision](.astraler-docs/01-context/product.md) - North star, priorities, anti-goals
49
- - [Constraints](.astraler-docs/01-context/constraints.md) - Technical & business boundaries
50
- - [Assumptions](.astraler-docs/01-context/assumptions.md) - Validatable assumptions
51
- - [Glossary](.astraler-docs/01-context/glossary.md) - Domain terminology
23
+ ## Documentation
52
24
 
53
- ### Technical Reference
54
- - [Tech Stack](.astraler-docs/03-arch/overview.md) - Technology choices, infrastructure
55
- - [Data Schema](.astraler-docs/03-arch/data-schema.md) - Database structure, relationships
56
- - [Engineering Standards](.astraler-docs/03-arch/standards.md) - DoD, code standards, testing
57
- - [Architecture Decisions](.astraler-docs/03-arch/decisions.md) - ADRs
25
+ All project documentation lives in `.astraler-docs/`:
58
26
 
59
- ### Business Requirements
60
- - [System Overview](.astraler-docs/02-spec/core/overview.md) - Actors, scope, boundaries
61
- - [Business Flows](.astraler-docs/02-spec/core/flows.md) - Cross-domain processes
62
- - [Business Rules](.astraler-docs/02-spec/core/rules.md) - Global constraints
27
+ | Document | What It Contains |
28
+ |----------|-----------------|
29
+ | [`atlas/`](.astraler-docs/atlas/) | **Complete project blueprint** (start here) |
30
+ | [`context/`](.astraler-docs/context/) | Constraints, assumptions, glossary |
31
+ | [`domains/`](.astraler-docs/domains/) | Deep-dives for complex domains (optional) |
32
+ | [`changes/`](.astraler-docs/changes/) | Change history and impact records |
33
+ | [`ai/`](.astraler-docs/ai/) | AI guardrails and quality gates |
63
34
 
64
- ### Implementation
65
- - [Milestones](.astraler-docs/04-tasks/milestones.md) - Epic-level goals
66
- - [Changelog](.astraler-docs/05-changes/changelog.md) - Change history
67
-
68
- ### AI Governance
69
- - [Guardrails](.astraler-docs/ai/guardrails.md) - AI agent constraints
70
- - [Rules](.astraler-docs/ai/rules.md) - Development rules
71
- - [Quality Gates](.astraler-docs/ai/quality_gates.md) - Test taxonomy, gates
35
+ See [`.astraler-docs/_index.md`](.astraler-docs/_index.md) for full navigation.
72
36
 
73
37
  ---
74
38
 
75
39
  ## Astra Commands
76
40
 
77
- ### Discovery & Status
78
-
79
41
  | Command | Purpose |
80
42
  |---------|---------|
81
43
  | `/astra:start` | Bootstrap project or scan existing codebase |
82
- | `/astra:status` | Show current project state and suggest next action |
83
- | `/astra:help` | List available commands and workflow guidance |
84
-
85
- ### Design Phase
86
-
87
- | Command | Purpose |
88
- |---------|---------|
89
- | `/astra:spec <domain>` | Create/update domain specification |
90
- | `/astra:arch <domain>` | Create/update domain architecture |
91
- | `/astra:plan <domain>` | Generate implementation tasks |
92
-
93
- ### Build Phase
94
-
95
- | Command | Purpose |
96
- |---------|---------|
97
- | `/astra:build <task> [--auto]` | Implement tasks with code + tests |
98
- | `/astra:verify` | Check documentation consistency |
99
-
100
- ### Governance
101
-
102
- | Command | Purpose |
103
- |---------|---------|
44
+ | `/astra:status` | Show current state and suggest next action |
104
45
  | `/astra:change <title>` | Manage changes to approved docs |
46
+ | `/astra:help` | List available commands |
105
47
 
106
48
  ---
107
49
 
108
50
  ## Development Rules
109
51
 
110
52
  ### Before Coding
111
- 1. Read the relevant [domain spec](.astraler-docs/02-spec/domains/) for business requirements
112
- 2. Read the relevant [domain arch](.astraler-docs/03-arch/domains/) for technical design
113
- 3. Check [engineering standards](.astraler-docs/03-arch/standards.md) for DoD
114
-
115
- ### Code Standards
116
- [CUSTOMIZE: Add your coding conventions]
117
-
118
- - Follow naming conventions in [standards](.astraler-docs/03-arch/standards.md)
119
- - Match existing patterns in the codebase
120
- - [CUSTOMIZE: Additional rules]
53
+ 1. Read [`atlas/index.md`](.astraler-docs/atlas/index.md) for project overview
54
+ 2. Check [`atlas/database.md`](.astraler-docs/atlas/database.md) for data models
55
+ 3. Review [`atlas/api.md`](.astraler-docs/atlas/api.md) for API contracts
56
+ 4. See [`ai/guardrails.md`](.astraler-docs/ai/guardrails.md) for AI rules
121
57
 
122
- ### Testing Requirements
123
- [CUSTOMIZE: Add your testing rules]
124
-
125
- - See [quality gates](.astraler-docs/ai/quality_gates.md) for test taxonomy
126
- - [CUSTOMIZE: Coverage requirements]
127
- - [CUSTOMIZE: Test naming conventions]
128
-
129
- ### Forbidden Patterns
130
- [CUSTOMIZE: Add patterns to avoid]
131
-
132
- - Never edit `Approved` docs without a CHG record
133
- - [CUSTOMIZE: Security anti-patterns]
134
- - [CUSTOMIZE: Architecture violations]
58
+ ### Critical Rules
59
+ - Never edit `Approved` docs without a Change Record (CHG)
60
+ - Atlas is the source of truth — changes flow Atlas → expanded docs
61
+ - [CUSTOMIZE: Add project-specific forbidden patterns]
135
62
 
136
63
  ---
137
64
 
@@ -160,26 +87,6 @@ All project documentation lives in `.astraler-docs/`. Read these before making c
160
87
  When requirements change:
161
88
  1. Run `/astra:change "<title>"` to create a change record
162
89
  2. Wait for impact analysis and human approval
163
- 3. Changes are applied to docs and tasks automatically
164
- 4. Run `/astra:verify` to confirm consistency
165
-
166
- See [changelog](.astraler-docs/05-changes/changelog.md) for recent changes.
167
-
168
- ---
169
-
170
- ## Domain Quick Links
171
-
172
- [CUSTOMIZE: Add your domains after running /astra:spec]
173
-
174
- | Domain | Spec | Arch | Tasks |
175
- |--------|------|------|-------|
176
- | [DOMAIN] | [spec](.astraler-docs/02-spec/domains/[DOMAIN].md) | [arch](.astraler-docs/03-arch/domains/[DOMAIN].arch.md) | [tasks](.astraler-docs/04-tasks/domains/[DOMAIN].tasks.md) |
177
-
178
- ---
179
-
180
- ## Navigation
90
+ 3. Changes propagate: Atlas expanded docs code
181
91
 
182
- - **New to project?** Start with [Product Vision](.astraler-docs/01-context/product.md)
183
- - **Understanding the system?** See [System Overview](.astraler-docs/02-spec/core/overview.md)
184
- - **Technical questions?** Check [Tech Stack](.astraler-docs/03-arch/overview.md) and [Data Schema](.astraler-docs/03-arch/data-schema.md)
185
- - **Need to implement?** See [Milestones](.astraler-docs/04-tasks/milestones.md)
92
+ See [`changes/changelog.md`](.astraler-docs/changes/changelog.md) for history.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "astragentic",
3
- "version": "1.0.0",
3
+ "version": "1.5.0",
4
4
  "description": "Installer for Astragentic devkit",
5
5
  "bin": {
6
6
  "astragentic": "./bin/cli.js"