Open Source · Quickstart
Prove the failure mode before integrating.
Start from source. The first demo shows why effect evidence matters even after an action was authorized.
1. Bootstrap a clean source checkout
npm run check:bootstrap
npm run check:source-manifest2. Run the quickstart
node packages/cli/bin/ruleoak.js demo quickstart3. Run the Effect Boundary demo
node packages/cli/bin/ruleoak.js demo effect-boundaryThe demo performs an external filesystem effect, loses the execution response, verifies the expected digest and refuses a duplicate retry when success is confirmed.
4. Inspect an MCP route without changing it
node packages/cli/bin/ruleoak.js protect --setup --dry-run5. Apply a supported boundary
node packages/cli/bin/ruleoak.js protect --setup --apply
node packages/cli/bin/ruleoak.js protect checkDo not treat READY_POLICY_ONLY as a full Effect Boundary. It means policy/interception works but trusted postcondition semantics are missing for at least one route.
6. Reconcile ambiguity without replay
node packages/cli/bin/ruleoak.js effect pending
node packages/cli/bin/ruleoak.js effect reconcile --limit 20
node packages/cli/bin/ruleoak.js effect retry-plan --id <effect-id>Optional npm convenience
Only after @ruleoak/cli@0.50.0 is actually public on npm:
npx @ruleoak/cli@0.50.0 demo quickstartBefore protecting real actions
- Choose one consequential path you control.
- Prove the action cannot bypass the RuleOak path accidentally.
- Confirm deny/approval-required prevents execution.
- Define a reviewed postcondition only if the real effect is externally observable.
- Exercise timeout/response-loss behavior.