opennori 0.1.0 → 0.1.2

package/README.md

@@ -1,12 +1,52 @@
 # OpenNori
 
-OpenNori.
+OpenNori helps coding agents deliver results that humans can actually accept.
 
-OpenNori gives coding agents a protocol surface centered on human acceptance criteria and evidence.
-The user sees whether the goal is satisfied, why, and what is still missing. The agent can still
-plan internally, but progress is determined by acceptance evidence.
+You describe a goal and constraints in natural language. Nori turns that into a Nori Contract:
+human-centered acceptance checks, evidence, and a completion report. The agent can still plan
+internally, but OpenNori treats progress as proven only when the acceptance checks have reviewable
+evidence.
 
-## Shape
+## Why It Exists
+
+AI agents often do a lot of work while leaving the user unsure whether the original goal is done.
+OpenNori keeps the conversation centered on:
+
+- what the user wants to achieve
+- what the user can open, run, see, or judge
+- what evidence supports each acceptance check
+- what is still blocked or missing
+- whether the goal is complete
+
+OpenNori is not a phase system, task planner, or process archive. It borrows productization ideas
+from mature agent workflow kits, but the main storyline stays acceptance, evidence, and completion
+judgment.
+
+## Try It
+
+```bash
+npx opennori install --root . --dry-run
+```
+
+For a project install:
+
+```bash
+npm install -D opennori
+npx nori install --root . --dry-run
+npx nori install --root . --confirm
+npx nori doctor --root .
+```
+
+Then talk to your agent:
+
+```text
+Use OpenNori for this project. Start from my goal, define a Nori Contract,
+and keep working only from acceptance gaps until the report says whether it is complete.
+```
+
+## What Gets Added
+
+OpenNori uses one project-local state directory:
 
 ```text
 .opennori/
@@ -21,55 +61,37 @@ plan internally, but progress is determined by acceptance evidence.
   brainstorms/
 ```
 
-## Quick Start
+It does not create a `process/` directory as the main workflow surface.
+
+## Core Commands
 
 ```bash
-node ./bin/nori.js install --root . --dry-run --json
-node ./bin/nori.js install --root . --skill --json
-node ./bin/nori.js doctor --root . --json
-node ./bin/nori.js skill export --pack --json
-node ./bin/nori.js brainstorm --idea "Explore a fuzzy goal before acceptance" --root . --json
-node ./bin/nori.js draft --from-brainstorm explore-a-fuzzy-goal-before-acceptance --candidate A --root . --json
-node ./bin/nori.js draft --goal "Ship a user-visible task" --root . --json
-node ./bin/nori.js approve --root . --summary "User approved acceptance criteria." --json
-node ./bin/nori.js init examples/opennori-self.json --root . --json
-node ./bin/nori.js resume --root . --json
-node ./bin/nori.js next --root . --json
-node ./bin/nori.js status --root . --json
-node ./bin/nori.js criterion update --root . --criterion AC-P-1 --user-story "作为用户，我能判断当前验收缺口。" --json
-node ./bin/nori.js evidence add --root . --criterion AC-P-1 --kind test-summary --summary "User can inspect the Nori Contract." --result passing --basis tool-observation --source '{"type":"command","label":"npm test","command":"npm test","outcome":"passed"}' --reviewability "User can rerun the command." --limitations "Does not prove visual UX." --json
-node ./bin/nori.js profile add --root . --type skill --name design-taste-frontend --strength must --purpose "Use this Skill for the design read and theme token pass." --install-policy existing_only --json
-node ./bin/nori.js profile add --root . --type stack --name radix-ui --strength prefer --purpose "Use accessible primitives for custom components." --install-policy ask_before_install --json
-node ./bin/nori.js profile show --root . --json
-node ./bin/nori.js profile evidence --root . --item skill-design-taste-frontend --result satisfied --summary "Agent used the required Skill before implementation." --json
-node ./bin/nori.js evaluate --root . --json
-node ./bin/nori.js report --root . --json
+nori install --root . --dry-run
+nori install --root . --confirm
+nori doctor --root .
+nori brainstorm --idea "Explore this goal" --root .
+nori draft --goal "Ship a user-visible result" --root .
+nori approve --root . --summary "User approved the acceptance checks."
+nori status --root .
+nori evidence add --root . --criterion AC-1 --kind review-result --summary "..." --result passing
+nori report --root .
 ```
 
-`nori install` writes `.opennori/manifest.json` with the OpenNori version, managed files, active goals,
-optional project Skill Pack state, and supported protocol capabilities. `nori doctor` reports whether a
-project is `ready`, `needs-action`, or `broken`, with recovery actions for missing structure, stale
-manifest data, broken active goals, and stale Skills.
-
-`nori install --dry-run` returns an `install_plan` that shows each planned action, asset kind,
-managed status, write intent, destructive overwrite flag, and reason. Dry-run plans report
-`will_write: 0` so users can review install impact before applying it.
-
-Real `nori install --force` requires `--confirm`. Preview destructive actions with
-`nori install --force --dry-run --json` before applying a confirmed overwrite.
-
-`nori uninstall --dry-run --json` previews removals. Default uninstall removes entry assets while
-preserving active goals, evidence, reports, archives, and brainstorms; deleting `.opennori` state
-requires `nori uninstall --include-state --confirm --json`.
+Users should not need to memorize these commands. The OpenNori Skill Pack lets an agent map natural
+language requests to the deterministic CLI state layer.
 
-Evidence is intentionally open-ended. Agents can use tests, diffs, screenshots, logs, artifacts,
-URLs, human confirmation, AW doctor, or any other useful signal. OpenNori only requires the submitted
-evidence to be reviewable by the user: include a basis, one or more sources, reviewability,
-confidence, and limitations when the evidence affects completion.
+## Productized Boundaries
 
-`nori install --skill` installs the OpenNori Skill Pack under `.agents/skills/`: the root `nori` router
-plus focused Skills for acceptance, evidence, Nori Profile, project health, and reporting.
-Users keep using natural language; the Skills route agent behavior to the right CLI loop.
+- `install`, `upgrade`, and `uninstall` support preview-first workflows; destructive writes require
+  explicit confirmation.
+- `doctor` reports whether project state is `ready`, `needs-action`, or `broken`, with recovery
+  actions.
+- Nori Profile records required Skills, preferred stacks, avoided tools, and install policy without
+  turning those preferences into user acceptance checks.
+- Evidence stays flexible: tests, screenshots, URLs, artifacts, logs, human confirmation, waivers, or
+  other reviewable sources can support an acceptance check.
+- Context export can give review tools the current goal, checks, profile, evidence, and report, but
+  review tools do not take over the agent loop.
 
 ## Development
 

package/examples/opennori-self.json

@@ -293,6 +293,22 @@
       "measurement": "运行 nori evidence add，分别使用 --source-command、--source-path、--source-url 和自由 --source 记录证据，再查看 status/report。",
       "threshold": "证据来源能显示为 command、artifact、url 或自由 reference；report/status 中仍保留 basis、reviewability、limitations 和 confidence。",
       "risk": "medium"
+    },
+    {
+      "id": "AC-Z-16",
+      "layer": "productization",
+      "user_story": "作为用户，我通过 npm 获取 OpenNori 后，能使用 nori 入口初始化项目、查看帮助和运行健康检查，而不需要理解迁移历史。",
+      "measurement": "在全新临时项目中安装 opennori 包，运行 npx nori --help、npx nori install --root . --dry-run、npx nori install --root . --confirm 和 npx nori doctor --root .。",
+      "threshold": "npm registry 显示 opennori@0.1.2 且 bin.nori 指向 bin/nori.js；全新项目安装后 npx nori 可用；dry-run 只预览 .opennori 写入；真实 install 后 doctor 为 ready；项目状态只出现 OpenNori 目录。",
+      "risk": "high"
+    },
+    {
+      "id": "AC-Z-17",
+      "layer": "productization",
+      "user_story": "作为用户，我第一次打开 README 时，能明确知道产品叫 OpenNori，它帮助 agent 交付人类可验收的结果，并看到最短试用入口。",
+      "measurement": "阅读 README 的开头、Try It、What Gets Added 和 Productized Boundaries 区域。",
+      "threshold": "README 开头说明 OpenNori 的核心价值；页面展示 npm/npx 试用方式、Nori Contract、.opennori 状态目录和验收证据闭环；用户不需要理解迁移历史就能开始试用。",
+      "risk": "high"
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opennori",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "OpenNori: human-centered Nori Contracts and evidence records for coding agents.",
   "type": "module",
   "bin": {