yarramate 0.5.0 → 0.7.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.
Files changed (48) hide show
  1. package/README.md +39 -10
  2. package/catalogues/core-enrichment.yaml +700 -0
  3. package/dist/adapters/likec4-cli.js +179 -55
  4. package/dist/adapters/likec4-export.d.ts +1 -1
  5. package/dist/adapters/likec4-prepare.d.ts +6 -0
  6. package/dist/adapters/likec4-prepare.js +40 -2
  7. package/dist/adapters/mcp-cli.js +55 -49
  8. package/dist/apply-command.d.ts +2 -0
  9. package/dist/apply-command.js +199 -0
  10. package/dist/{new-command.d.ts → ask-command.d.ts} +1 -1
  11. package/dist/ask-command.js +729 -0
  12. package/dist/brief.d.ts +3 -0
  13. package/dist/brief.js +235 -0
  14. package/dist/check-command.js +70 -4
  15. package/dist/cli-support.d.ts +4 -1
  16. package/dist/cli-support.js +3 -2
  17. package/dist/cli.js +22 -586
  18. package/dist/compiler.js +45 -7
  19. package/dist/core-contract.d.ts +1 -1
  20. package/dist/{status-command.d.ts → design-command.d.ts} +1 -1
  21. package/dist/design-command.js +218 -0
  22. package/dist/export-command.d.ts +2 -0
  23. package/dist/export-command.js +228 -0
  24. package/dist/interrogate-command.d.ts +104 -0
  25. package/dist/interrogate-command.js +268 -0
  26. package/dist/next-command.d.ts +22 -0
  27. package/dist/next-command.js +167 -0
  28. package/dist/reconciliation.d.ts +2 -0
  29. package/dist/reconciliation.js +38 -0
  30. package/docs/CONSUMING-YARRAMATE.md +28 -21
  31. package/package.json +13 -10
  32. package/schema/yarramate-apply-result.schema.json +32 -0
  33. package/schema/yarramate-ask-result.schema.json +391 -0
  34. package/schema/yarramate-check-result.schema.json +12 -0
  35. package/schema/yarramate-core-contract.schema.json +5 -10
  36. package/schema/yarramate-design-step.schema.json +152 -0
  37. package/schema/yarramate-document.schema.json +76 -9
  38. package/schema/yarramate-interrogation-report.schema.json +89 -0
  39. package/schema/yarramate-likec4-generated-project-v2.schema.json +6 -0
  40. package/schema/yarramate-likec4-generated-project.schema.json +6 -0
  41. package/schema/yarramate-operations.schema.json +303 -0
  42. package/schema/yarramate-question-catalogue.schema.json +431 -0
  43. package/schema/yarramate-reconciliation-report.schema.json +8 -2
  44. package/skills/yarramate-architecture/SKILL.md +42 -17
  45. package/skills/yarramate-architecture/references/native-authoring.md +73 -17
  46. package/dist/new-command.js +0 -111
  47. package/dist/status-command.js +0 -171
  48. package/schema/yarramate-status-result.schema.json +0 -273
package/README.md CHANGED
@@ -5,9 +5,14 @@
5
5
  [![CodeQL](https://github.com/yarrasys/yarramate/actions/workflows/codeql.yml/badge.svg)](https://github.com/yarrasys/yarramate/actions/workflows/codeql.yml)
6
6
  [![license: MIT](https://img.shields.io/github/license/yarrasys/yarramate)](LICENSE)
7
7
 
8
- YarraMate is a tool-neutral semantic architecture engine and guided
9
- methodology. It turns architectural intent into deterministic, testable
10
- context shared by people and agents.
8
+ YarraMate keeps your coding agents' architecture context correct. Declare
9
+ the design once, as a checked model in git; agents receive prose rendered
10
+ from it — bounded briefs and open design questions — and the CLI
11
+ mechanically proves the model still matches the code as changes land.
12
+
13
+ Prose is the interface; structure is the guarantee: every sentence an agent
14
+ reads stands on a graph whose names resolve, whose drift is detected, and
15
+ whose gaps are found deterministically.
11
16
 
12
17
  > YarraMate is pre-release software. Interfaces may evolve before the first
13
18
  > stable release.
@@ -57,6 +62,7 @@ src/ compiler, CLI, graph, and adapter sources
57
62
  schema/ normative JSON Schemas
58
63
  test/ tests and acceptance fixtures
59
64
  skills/ portable architecture workflow for agent harnesses
65
+ .claude-plugin/ plugin marketplace manifest offering that skill
60
66
  docs/ contracts, guides, and decisions
61
67
  .yarramate/ canonical dogfooded architecture
62
68
  .yarramate-out/ reproducible generated output (ignored)
@@ -106,7 +112,14 @@ npm install --global yarramate
106
112
  yarramate --help
107
113
 
108
114
  npx yarramate check .yarramate/workspace.yaml
109
- npx yarramate status .yarramate/workspace.yaml --json
115
+ npx yarramate ask .yarramate/workspace.yaml
116
+ ```
117
+
118
+ The CLI is seven verbs, one per lifecycle stage:
119
+
120
+ ```text
121
+ init → design → apply → ask → check → reconcile → export
122
+ create fill write read gate drift derive
110
123
  ```
111
124
 
112
125
  When developing the repository, build and invoke the same executable surface:
@@ -115,17 +128,26 @@ When developing the repository, build and invoke the same executable surface:
115
128
  pnpm build
116
129
 
117
130
  node dist/cli.js init .
131
+ node dist/cli.js design .yarramate/workspace.yaml
132
+ node dist/cli.js apply operations.yaml .yarramate/workspace.yaml
133
+ node dist/cli.js ask .yarramate/workspace.yaml
134
+ node dist/cli.js ask .yarramate/workspace.yaml "free text about the model"
135
+ node dist/cli.js ask .yarramate/workspace.yaml --subjects
136
+ node dist/cli.js ask .yarramate/workspace.yaml --advise "a design question"
118
137
  node dist/cli.js check .yarramate/workspace.yaml --json
119
- node dist/cli.js compile .yarramate/workspace.yaml
120
- node dist/cli.js context .yarramate/projections/context.yaml .yarramate/workspace.yaml
121
- node dist/cli.js view .yarramate/projections/context.yaml .yarramate/workspace.yaml
122
- node dist/cli.js evidence .yarramate/evidence/repository.yaml .yarramate/workspace.yaml
123
138
  node dist/cli.js reconcile .yarramate/workspace.yaml
139
+ node dist/cli.js export graph .yarramate/workspace.yaml
140
+ node dist/cli.js export briefs .yarramate/projections/context.yaml .yarramate/workspace.yaml --out handoff
124
141
  ```
125
142
 
126
143
  `init` creates `.yarramate/architecture/main.yaml` and
127
- `.yarramate/workspace.yaml`. Commands accept explicit source documents or one
128
- explicit workspace manifest.
144
+ `.yarramate/workspace.yaml` and delivers the agent pointer. `design`
145
+ serves the top open design question; `apply` lands answers as one
146
+ validated atomic batch; `ask` is every consumed-now read; `export`
147
+ derives persisted artifacts. `check --strict` additionally fails when
148
+ any evidence observation contradicts the model, for gates that want one
149
+ knob. The full contract is
150
+ [docs/AGENT-INTERFACE.md](docs/AGENT-INTERFACE.md).
129
151
 
130
152
  For a local consumer test, create a package artifact:
131
153
 
@@ -138,6 +160,13 @@ yarramate --help
138
160
  See [Consuming YarraMate](docs/CONSUMING-YARRAMATE.md) for the packaged CLI,
139
161
  schemas, agent skill, and optional adapters.
140
162
 
163
+ In Claude Code, this repository is its own plugin marketplace:
164
+
165
+ ```sh
166
+ /plugin marketplace add yarrasys/yarramate
167
+ /plugin install yarramate-architecture@yarramate
168
+ ```
169
+
141
170
  ## Library API
142
171
 
143
172
  The typed library exposes the same deep compiler seam: