Skip to content

Getting Started

Install the CLI

bash
npm install -g @uks/cli

Validate your first packet

bash
uks validate my-packet.uks.json

A valid packet prints:

✓ my-packet.uks.json
  conformance level: L1 ✓

Inspect a packet

bash
uks info my-packet.uks.json
Packet:  uks-omega3-v1
Topic:   Omega-3 Fatty Acids
Level:   L1
Sources: 12
  Layer A: ✓  Layer B: ✗  Layer C: ✗  Layer D: ✗  Layer E: ✗
Top sources:
  1. EPA and DHA supplementation and cardiovascular risk (high)
  2. Omega-3 index as a cardiovascular risk factor (moderate)
  ...

Serve via MCP

bash
uks serve my-packet.uks.json

This prints a claude_desktop_config.json snippet. Paste it into your Claude Desktop config and your packet becomes a live knowledge source.

Publish to the registry

bash
# Generate a key (store it safely — you'll need it to unpublish)
uks config generate-key

# Publish
uks publish my-packet.uks.json

# Others can find it with:
uks search "omega-3 EPA DHA"

Next Steps

Released under the MIT License.