mikoshi-construct 0.1.1 → 0.1.2

package/README.md

@@ -3,8 +3,10 @@
 Bootstrap for AI-native software projects. Start with a proven engineering workflow instead of an
 empty repository.
 
-```
-npx mikoshi-construct init
+```bash
+mkdir my-service && cd my-service
+npx mikoshi-construct init          # interactive: preset, agent, project name
+pnpm install && pnpm run quality    # green before you write a line
 ```
 
 > **v0.1.** Presets `node-backend`, `node-frontend`, `node-library` and `monorepo`. Claude Code gets
@@ -34,6 +36,52 @@ An existing repository gets the policy, the harness tooling and the agent files,
 code; its own `AGENTS.md`, `CLAUDE.md`, `package.json` and configs are merged or left alone, and
 `init` says what still has to be wired by hand.
 
+## Usage
+
+**A new project.** Name a preset and it writes everything:
+
+```bash
+mkdir my-service && cd my-service
+npx mikoshi-construct init --yes --preset node-backend
+pnpm install && pnpm run quality
+```
+
+**An existing repository.** Look before you write:
+
+```bash
+npx mikoshi-construct init --preset monorepo --dry-run
+```
+
+```
+  ~ package.json (merge)
+  = eslint.config.mjs — exists, review manually
+  + architecture/principles.md
+  + .claude/commands/construct-discover.md
+
+  Sample sources omitted: the directory is not empty. Discovery maps what is already here.
+```
+
+`+` creates a file that is not there. `~` merges into one that is, inside a
+`construct:begin … construct:end` block or as a JSON merge where your values win. `=` leaves the file
+alone and reports it. No example code lands in a repository that already has some, and there is no
+`--force`.
+
+**Cursor, or both agents.** The rules are written once and rendered for each:
+
+```bash
+npx mikoshi-construct init --yes --preset node-frontend --ai both
+```
+
+**Check a repository at any time.**
+
+```bash
+npx mikoshi-construct doctor     # baseline intact, harness intact, markers filled
+npx mikoshi-construct soulkill   # what the detector sees; writes nothing
+npx mikoshi-construct cost --last
+```
+
+Every command, flag and exit code: [docs/cli.md](https://github.com/E1i/mikoshi-construct/blob/main/docs/cli.md).
+
 ## Three principles
 
 1. **CLI detects facts. Agent interprets the system.** Everything that needs understanding of the
@@ -82,7 +130,8 @@ with a named check, not a second fix.
 | `construct soulkill` | Print what the detector sees, write nothing (`--json`; aliases `inspect`, `capture`) |
 | `construct cost` | Token usage of the `/implement` runs in this directory, per agent, billable and price-weighted (`--last`, `--json`) |
 
-`--plain` turns off colours and lore for CI. `--johnny` — wake up, Netrunner.
+`--plain` turns off colours and lore for CI. `--johnny` — wake up, Netrunner. The full reference,
+with examples and exit codes, is in [docs/cli.md](https://github.com/E1i/mikoshi-construct/blob/main/docs/cli.md).
 
 > If you already keep a user-level `implement` skill in `~/.claude/skills/`, it shadows the one the
 > construct puts in `.claude/skills/implement/`; move yours aside to run the repository's ladder.

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "mikoshi-construct",
   "type": "module",
-  "version": "0.1.1",
-  "packageManager": "pnpm@12.4.2",
+  "version": "0.1.2",
   "description": "Bootstrap for AI-native software projects. Start with a proven engineering workflow instead of an empty repository.",
   "author": "Eli Tabrisov",
   "license": "MIT",
@@ -36,23 +35,6 @@
   "engines": {
     "node": ">=20"
   },
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsx src/cli.ts",
-    "lint": "eslint .",
-    "lint:fix": "eslint --fix .",
-    "typecheck": "tsc --noEmit",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "quality": "pnpm composition:check && pnpm lint && pnpm typecheck && pnpm test",
-    "prepublishOnly": "pnpm build",
-    "composition:render": "tsx scripts/composition/sync-docs.ts",
-    "composition:check": "tsx scripts/composition/check.ts",
-    "ci": "pnpm run quality",
-    "changeset": "changeset",
-    "version-packages": "changeset version",
-    "release": "pnpm build && npm publish --provenance --access public"
-  },
   "dependencies": {
     "@clack/prompts": "^1.8.0",
     "citty": "^0.2.2",
@@ -69,5 +51,21 @@
     "typescript": "^5.9.3",
     "vitest": "^5.0.0",
     "yaml": "^2.9.1"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsx src/cli.ts",
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix .",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "quality": "pnpm composition:check && pnpm lint && pnpm typecheck && pnpm test",
+    "composition:render": "tsx scripts/composition/sync-docs.ts",
+    "composition:check": "tsx scripts/composition/check.ts",
+    "ci": "pnpm run quality",
+    "changeset": "changeset",
+    "version-packages": "changeset version",
+    "release": "pnpm build && changeset publish"
   }
-}
+}