create-uks-packet
v1.0.0
Published
Scaffold a publish-ready UKS knowledge-packet repo — npm create uks-packet@latest
Downloads
152
Maintainers
Readme
create-uks-packet
Scaffold a publish-ready UKS knowledge-packet repo in one command — the create-react-app pattern for verified knowledge.
npm create uks-packet@latest creatine-evidence -- --topic "Creatine for cognition" --level L2 --signYou get:
| File | Purpose |
|------|---------|
| <slug>.uks.json | A schema-valid starter packet at the chosen level (L1/L2/L3) — green in CI on day one |
| package.json | Wired to @uks/cli with validate / publish:packet / publish:signed scripts |
| .github/workflows/uks.yml | The official uks-action — every push/PR gates the packet against the UKS v3.0 schema |
| .uks/config.json | Packet metadata (level, file, schema version) |
| README.md, .gitignore | Docs + sensible ignores (the signing key is git-ignored) |
| signing-key.pem / .pub.pem | (with --sign) an Ed25519 keypair for signed publishing |
Options
npm create uks-packet@latest <dir> [options]
-t, --topic <text> Packet topic (seeds the slug + the starter packet)
-l, --level <L1|L2|L3> Conformance level (default L1)
--slug <name> Override the file/package slug
--sign Generate an Ed25519 signing keypair
-f, --force Scaffold into a non-empty directory
-h, --help Show helpThen
cd creatine-evidence
npm install
npm run validate # validate against the UKS v3.0 schema
# edit the packet — replace placeholder sources with real, graded, licensed ones
uks config set registry.apiKey st_live_xxxx # one-time: set your SaberTools API key
uks publish creatine-evidence.uks.json # publish to the registrySigning + CI validation are wired in from the first commit, so every new packet repo starts trustworthy by default.
