KYE OSS packages
Every package below is Apache 2.0, published to npm or PyPI, with source on GitHub under github.com/KYE-Protocol. The schema set is mirrored from kyeprotocol.com/schemas/ at every release.
Plain Q&A
Short questions. Short answers.
- What is open? Schemas, vocab, SDKs, verifier.
- What is closed? Nothing in the protocol layer.
- Which licence? Apache 2.0 for code. CC-BY-4.0 for vocab.
- Where is the source? On GitHub. KYE-Protocol org.
- Can I fork? Yes.
- Can I contribute? Yes. Open a PR.
- Will you take my fix? Yes if it follows the constitution.
- Is the runtime open? Reference Gateway is. Hardened build is paid.
Plain take
Apache 2.0 SDKs. CC-BY-4.0 vocab. No runtime lock-in.
- Three SDKs. One protocol. Same names.
- Schemas and vocab versioned on GitHub.
- Public JWKS. Open verifier.
- Bring your own runtime.
| Package | Language | Version | Install | Source |
|---|---|---|---|---|
| @kye/shadow-mode-sdk Builder + ingest client + local mode |
TypeScript | 0.1.0 | npm i @kye/shadow-mode-sdk |
github |
| kye-shadow-mode Python equivalent of shadow-mode-sdk |
Python 3.11+ | 0.1.0 | pip install kye-shadow-mode |
github |
| @kye/conformance-pack-verifier Offline verifier for Evidence Packs |
TypeScript (CLI) | 0.1.0 | npx @kye/conformance-pack-verifier |
github |
| @kye/cli Full-fat KYE command line |
TypeScript (CLI) | 0.1.0 | npm i -g @kye/cli |
github |
| @kye/widget-protocol Embeddable widget contract + web component |
TypeScript | 0.1.0 | npm i @kye/widget-protocol |
github |
| kye-schemas JSON Schema 2020-12 set, mirrored |
Schema | 1.0.0 | npm i kye-schemas |
github |
| kye-fixtures Synthetic observed-action streams |
Data | 1.0.0 | npm i kye-fixtures |
github |
Compatibility
Short take. Big idea.
Node 20+
All TypeScript packages require Node 20 LTS or higher. ESM-only.
Python 3.11+
The Python SDK uses StrEnum and the modern typing module.
Schema versioning
Every schema carries a $id with absolute URI under kyeprotocol.com/schemas/. Semver-locked.