# OKFShare

> Publish and retrieve small, versioned OKF Markdown knowledge bundles.

OKFShare is a hosted publishing service for agent-readable knowledge. It validates
OKF Markdown bundles, renders public share pages, and provides authenticated source
retrieval.

## Links

## Start here

Run the canonical onboarding command first:

`npx okfshare@latest setup`

This configures authentication and workspace binding. Use `doctor` to check
the binding, credential expiry, API reachability, and configured bindings.

- Canonical site: https://okfshare.app/
- Full documentation: https://okfshare.app/llms-full.txt
- OKF v0.2 specification: https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md
- CLI: https://www.npmjs.com/package/okfshare (use `npx okfshare@latest`)
- Setup and API guide: https://okfshare.app/llms-full.txt

## Authentication

Browserless onboarding cannot complete device-code pairing: it requires a human
to open the verification URL and approve the device. If a pre-provisioned API
key or CLI credential is available, supply it through `OKFSHARE_TOKEN` outside
chat, command-line arguments, and project files. Agents may inspect only whether
the variable exists, never its value. Verify access with `whoami` and `doctor`.

Use `workspace:read` for retrieval, search, and context. Use `workspace:write`
for publishing, updating, and other mutations. Never publish secrets or sensitive
data.