mikoshi-construct 0.2.0 → 0.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/README.md CHANGED
@@ -3,14 +3,18 @@
3
3
  Bootstrap for AI-native software projects. Start with a proven engineering workflow instead of an
4
4
  empty repository.
5
5
 
6
+ **[Documentation](https://e1i.github.io/mikoshi-construct/)** · [Getting started](https://e1i.github.io/mikoshi-construct/guide/getting-started) · [The development cycle](https://e1i.github.io/mikoshi-construct/guide/the-cycle) · [CLI reference](https://e1i.github.io/mikoshi-construct/cli)
7
+
6
8
  ```bash
7
9
  mkdir my-service && cd my-service
8
10
  npx mikoshi-construct init # interactive: preset, agent, project name
9
11
  pnpm install && pnpm run quality # green before you write a line
10
12
  ```
11
13
 
12
- > **v0.1.** Presets `node-backend`, `node-frontend`, `node-library` and `monorepo`. Claude Code gets
14
+ > **v0.3.** Presets `node-backend`, `node-frontend`, `node-library` and `monorepo`. Claude Code gets
13
15
  > the full lifecycle; Cursor gets the rules, the conventions and the discovery protocol.
16
+ > `construct sync` moves a repository already carrying a construct onto newer templates.
17
+
14
18
 
15
19
  ## What it does
16
20
 
@@ -76,10 +80,14 @@ npx mikoshi-construct init --yes --preset node-frontend --ai both
76
80
 
77
81
  ```bash
78
82
  npx mikoshi-construct doctor # baseline intact, harness intact, markers filled
83
+ npx mikoshi-construct sync # what newer templates would change; writes nothing
79
84
  npx mikoshi-construct soulkill # what the detector sees; writes nothing
80
85
  npx mikoshi-construct cost --last
81
86
  ```
82
87
 
88
+ `sync` reports and changes nothing until you ask for `--apply`, and even then it writes only what
89
+ the construct itself wrote and you have not touched.
90
+
83
91
  Every command, flag and exit code: [docs/cli.md](https://github.com/E1i/mikoshi-construct/blob/main/docs/cli.md).
84
92
 
85
93
  ## Three principles
@@ -139,6 +147,7 @@ with a named check, not a second fix.
139
147
  |---|---|
140
148
  | `construct init` | Detect, configure, materialize. `--yes --preset node-backend\|node-frontend\|node-library\|monorepo --ai claude\|cursor\|both --review claude --dir . --dry-run` |
141
149
  | `construct doctor` | Baseline files present, harness intact, discovery markers filled — `GLITCH` by name when not |
150
+ | `construct sync` | Classify every path against today's templates and report; `--apply` writes only what the construct owns and you have not changed (`--json`) |
142
151
  | `construct soulkill` | Print what the detector sees, write nothing (`--json`; aliases `inspect`, `capture`) |
143
152
  | `construct cost` | Token usage of the `/implement` runs in this directory, per agent, billable and price-weighted (`--last`, `--json`) |
144
153
 
@@ -176,6 +185,12 @@ The names are a tribute to Cyberpunk 2077 and mean exactly one thing each here.
176
185
  | Soulkiller | `construct soulkill`: extracts the facts about a repository and writes nothing |
177
186
  | Netrunner | The coding agent — Claude Code, Cursor — that connects to the project through the construct |
178
187
  | Relic | The files at the root the agent reads first: `AGENTS.md`, `CLAUDE.md`, `construct.json` |
188
+ | Engram | The record `init` cut into `construct.json`: what the construct wrote, and the version that wrote it |
189
+ | Braindance | `construct sync`: replaying that engram against today's templates and reporting where the two disagree |
190
+ | Relic write | `construct sync --apply`: the one write into a repository the construct did not create |
191
+ | Blackwall | Where a construct block whose template variant cannot be established sits — not yours, not ours, and nothing is written there |
192
+ | Glitch | A warning in the output. Something wants a human; nothing has failed |
193
+ | Flatlined | A check that failed outright: a missing baseline file, or no `construct.json` where one was required |
179
194
  | Harness | No lore. `pnpm run quality`. The one word that must be understood without this table |
180
195
 
181
196
  Not affiliated with CD Projekt Red.