examples

Examples

Activate And Preview

Preview what your agent will know and generate setup, proof, and Inspector output in one folder:

npx -y okfy-ai activate stripe --client codex --out okfy-activation
npx -y okfy-ai activate examples/bundles/okfy-docs --client codex --out okfy-activation

The activation packet includes okfy-inspector.html, okfy-setup.md, and okfy-proof.json.

Preview only the Inspector when you do not need the setup/proof packet:

npx -y okfy-ai map stripe --out okfy-inspector.html
npx -y okfy-ai map examples/bundles/okfy-docs --out okfy-inspector.html

The Inspector is local static HTML for checking readiness, source freshness, citation URLs, concept relationships, and the MCP sequence before asking an agent to use the bundle.

bundles/okfy-docs

Purpose: committed offline OKF bundle used by okfy demo.

Source command:

npx -y okfy-ai import examples/local-markdown --out /tmp/okfy-docs --source-name "okfy docs" --force --stable-timestamps
npx -y okfy-ai validate /tmp/okfy-docs

Expected concept count:

6

Expected validation status:

valid

Suggested agent questions:

• Search for crawler security defaults, read the relevant concepts, and cite the source resource.
• Read the MCP setup concept and explain the stdio config.
• Find importer concepts and list supported input formats.

bundles/stripe-checkout-small

Purpose: small curated Stripe Checkout sample for launch demos when live crawling is flaky. The generated OKF bundle is committed so package users can inspect it without the repo-only source fixture.

Try it:

npx -y okfy-ai validate examples/bundles/stripe-checkout-small
npx -y okfy-ai activate examples/bundles/stripe-checkout-small --client codex --out stripe-activation
npx -y okfy-ai map examples/bundles/stripe-checkout-small --out stripe-inspector.html

Expected concept count:

4

Expected validation status:

valid

Suggested agent questions:

• Search for Checkout Sessions, read the strongest match, and explain required server parameters.
• Find webhook-related concepts and summarize fulfillment safety notes.
• Use neighbors to move from the quickstart to the API reference and webhook concepts.

local-markdown

Purpose: deterministic offline input for okfy import.

Source command:

okfy import ./examples/local-markdown --out ./tmp/okfy-docs --force --stable-timestamps

Expected concept count:

6

Expected validation status:

valid

Validate:

okfy validate ./tmp/okfy-docs
okfy inspect ./tmp/okfy-docs
okfy activate ./tmp/okfy-docs --client codex --out okfy-activation
okfy map ./tmp/okfy-docs --out okfy-inspector.html

Serve through MCP:

okfy serve ./tmp/okfy-docs --mcp

Suggested agent questions:

• Search for import workflow concepts, read the best match, and explain how to convert a local Markdown folder into OKF.
• Find concepts tagged mcp, read the MCP tools concept, and describe the expected tool-call sequence.
• Read the bundle summary, then identify which concepts are most useful for a first-time okfy user.