diff --git a/cli/README.md b/cli/README.md index aa5e489..296020d 100644 --- a/cli/README.md +++ b/cli/README.md @@ -1,3 +1,18 @@ # CLI -CLI verifier placeholder. The first public draft uses Python tools. +No standalone CLI is shipped in this public v0.1 draft. + +For now, use the Python validator from the repository root: + +```bash +python3 -m pip install -r requirements.txt +python3 tools/validate-receipts.py +``` + +Future CLI work should stay limited to public schema validation and local +developer ergonomics unless a separate production design is approved. + +The CLI must not implement production signing, issuer internals, scoped key +generation, Passpod Hub internals, customer workflows, or private commercial +logic. Production-valid receipts require authorized issuer access through +Passpod Hub and the Pilot Access Engine. diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..c2a750e --- /dev/null +++ b/examples/README.md @@ -0,0 +1,61 @@ +# Example Receipts + +This directory contains public demo Trust Action Receipts for Passpod TASK Core. +They are intentionally sanitized examples for learning, schema validation, and +tooling tests. + +These receipts are valid public examples, not production-valid receipts. They +use `demo-signature-not-production` and do not include production receipt IDs, +policy references, proof references, customer workflows, issuer internals, or +scoped key logic. + +Production-valid receipts require authorized issuer access through Passpod Hub +and the Pilot Access Engine. + +## remote-worker.receipt.json + +Demonstrates a Remote Worker TrustPass-style reference check. + +- `scenario_id`: `remote_worker_reference_check` +- `action`: `request_work_reference_trustpass` +- `decision`: `review_required` +- Why it matters: work-reference requests should collect consent and context + before a trust decision is made. + +## refund-review.receipt.json + +Demonstrates a high-risk refund approval that needs review before execution. + +- `scenario_id`: `high_risk_refund_review` +- `action`: `approve_high_risk_refund` +- `decision`: `review_required` +- Why it matters: large or risky refund actions should not execute silently. + +## agent-freeze.receipt.json + +Demonstrates a freeze decision for abnormal agent behavior. + +- `scenario_id`: `agent_emergency_freeze` +- `action`: `freeze_agent_execution` +- `decision`: `freeze` +- Why it matters: unsafe or abnormal agent actions may need immediate pause + before further execution. + +## Validate examples + +From the repository root: + +```bash +python3 -m pip install -r requirements.txt +python3 tools/validate-receipts.py +``` + +Expected result: + +```text +schema-valid public demo receipt +``` + +That means the JSON matches the public draft schema and keeps the public demo +safety boundary. It does not mean hosted issuance, production signature +verification, or commercial authorization. diff --git a/validator/README.md b/validator/README.md index 882dad0..90d626b 100644 --- a/validator/README.md +++ b/validator/README.md @@ -1,3 +1,43 @@ # Validator -Use `python3 tools/validate-receipts.py` for now. +The public validator checks the example Trust Action Receipts against the +public JSON Schema and the demo-only safety boundary. + +It validates that: + +- each `examples/*.receipt.json` file is JSON; +- each example matches `schemas/trust-action-receipt.schema.json`; +- public examples keep `demo-signature-not-production`; +- public examples do not claim production receipt IDs, policy references, or + proof references. + +## Install + +From the repository root: + +```bash +python3 -m pip install -r requirements.txt +``` + +## Run + +```bash +python3 tools/validate-receipts.py +``` + +Expected output includes: + +```text +schema-valid public demo receipt +``` + +## Boundary + +A passing validator result means the receipt is a valid public demo example. It +does not mean the receipt was issued, signed, stored, or verified by a +production service. + +Production-valid receipts require authorized issuer access through Passpod Hub +and the Pilot Access Engine. This repository does not contain production +signing internals, scoped key generation, issuer logic, customer workflows, or +Passpod Hub internals.