Add a zero-config quickstart example: governance in 30 seconds#49
Open
davidcrowe wants to merge 1 commit into
Open
Add a zero-config quickstart example: governance in 30 seconds#49davidcrowe wants to merge 1 commit into
davidcrowe wants to merge 1 commit into
Conversation
The on-ramp led with `identifiabl` (JWT), which 401s every request until you stand up an IdP — so a new developer's first run showed nothing working. This adds a runnable, zero-config first win. `examples/quickstart` is a ~50-line script over the pure `-core` packages that prints three real decisions with no IdP, backend, or config: - deny-by-default policy (validatabl) — read_file allowed, delete_database denied - PII redaction (transformabl) — email + SSN → [EMAIL]/[SSN] - rate limit (limitabl) — the 4th call in the window is refused It uses only currently-published package versions, so `npm install && npm start` works today. README now offers this as the "see it work first" path before the IdP-backed middleware setup. CLAUDE.md's stale "tests are not yet implemented" status is corrected (suites exist under __tests__/). Deliberately does NOT demo the "rm -rf hardline" — that classifier lives in the private prod engine, not OSS; showing it here would claim a capability the repo doesn't ship. Verified: `npm run build` + the example runs and prints the decisions.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Makes the OSS on-ramp deliver a zero-config first win, part of the star-push credibility work.
The problem
The Install/Quickstart led with
identifiabl(JWT verification), which 401s every request until you stand up an IdP. A developer's very first run showed nothing working and no way to see the product do anything without external setup — the worst on-ramp for a product whose whole thesis is "stars and real implementations are the moat."What this adds
examples/quickstart— a ~50-line script over the pure-corepackages that prints three real governance decisions with no IdP, backend, or config:read_fileallowed,delete_databasedenied by default[EMAIL]/[SSN]It pins to currently-published package versions, so
npm install && npm startworks today. The root README now offers this as the "see it work first" path before the IdP-backed middleware setup.CLAUDE.md's stale "tests are not yet implemented" status is corrected (suites live under__tests__/).Honesty note
Deliberately does not demo the "rm -rf hardline" — that classifier lives in the private prod engine, not OSS. Demoing it here would claim a capability the repo doesn't ship (the same trap as the conformance badge in #39).
Verification
npm run buildclean; the example runs and prints the three decisions.Sequencing
Additive (
examples/is a new dir); the README pointer sits in a region the pending cleanup PRs don't touch. The larger README reframe (leading with the zero-config win) should land after #44/#48 to avoid conflicts. Not merged.