yarramate 0.6.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.
- package/README.md +39 -12
- package/catalogues/core-enrichment.yaml +700 -0
- package/dist/adapters/mcp-cli.js +55 -49
- package/dist/apply-command.d.ts +2 -0
- package/dist/apply-command.js +199 -0
- package/dist/{new-command.d.ts → ask-command.d.ts} +1 -1
- package/dist/ask-command.js +729 -0
- package/dist/brief.d.ts +3 -0
- package/dist/brief.js +235 -0
- package/dist/cli-support.d.ts +1 -1
- package/dist/cli-support.js +1 -1
- package/dist/cli.js +22 -590
- package/dist/compiler.js +13 -0
- package/dist/core-contract.d.ts +1 -1
- package/dist/{status-command.d.ts → design-command.d.ts} +1 -1
- package/dist/design-command.js +218 -0
- package/dist/export-command.d.ts +2 -0
- package/dist/export-command.js +228 -0
- package/dist/interrogate-command.d.ts +104 -0
- package/dist/interrogate-command.js +268 -0
- package/dist/next-command.d.ts +5 -8
- package/dist/next-command.js +106 -211
- package/docs/CONSUMING-YARRAMATE.md +28 -21
- package/package.json +13 -11
- package/schema/yarramate-apply-result.schema.json +32 -0
- package/schema/yarramate-ask-result.schema.json +391 -0
- package/schema/yarramate-core-contract.schema.json +5 -11
- package/schema/yarramate-design-step.schema.json +152 -0
- package/schema/yarramate-document.schema.json +76 -9
- package/schema/yarramate-interrogation-report.schema.json +89 -0
- package/schema/yarramate-operations.schema.json +303 -0
- package/schema/yarramate-question-catalogue.schema.json +431 -0
- package/skills/yarramate-architecture/SKILL.md +42 -17
- package/skills/yarramate-architecture/references/native-authoring.md +73 -17
- package/dist/new-command.js +0 -111
- package/dist/status-command.js +0 -174
- package/schema/yarramate-next-result.schema.json +0 -85
- package/schema/yarramate-status-result.schema.json +0 -278
package/README.md
CHANGED
|
@@ -5,9 +5,14 @@
|
|
|
5
5
|
[](https://github.com/yarrasys/yarramate/actions/workflows/codeql.yml)
|
|
6
6
|
[](LICENSE)
|
|
7
7
|
|
|
8
|
-
YarraMate
|
|
9
|
-
|
|
10
|
-
|
|
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
|
|
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,19 +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 next .yarramate/projections/context.yaml .yarramate/workspace.yaml
|
|
123
|
-
node dist/cli.js evidence .yarramate/evidence/repository.yaml .yarramate/workspace.yaml
|
|
124
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
|
|
125
141
|
```
|
|
126
142
|
|
|
127
143
|
`init` creates `.yarramate/architecture/main.yaml` and
|
|
128
|
-
`.yarramate/workspace.yaml
|
|
129
|
-
|
|
130
|
-
|
|
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).
|
|
131
151
|
|
|
132
152
|
For a local consumer test, create a package artifact:
|
|
133
153
|
|
|
@@ -140,6 +160,13 @@ yarramate --help
|
|
|
140
160
|
See [Consuming YarraMate](docs/CONSUMING-YARRAMATE.md) for the packaged CLI,
|
|
141
161
|
schemas, agent skill, and optional adapters.
|
|
142
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
|
+
|
|
143
170
|
## Library API
|
|
144
171
|
|
|
145
172
|
The typed library exposes the same deep compiler seam:
|