@uks/cli

Command-line validator, inspector, and registry client for Universal Knowledge & Action Schema (UKS) v3.0 packets. Installs the uks command.

npm install -g @uks/cli

Commands

uks validate <file.uks.json>          Validate against UKS v3.0 schema
uks info     <file.uks.json>          Human-readable packet summary
uks test     [--suite <dir>]          Run conformance test suite

uks convert  --from bibtex <file.bib> Convert BibTeX → UKS L1
uks convert  --from ris    <file.ris> Convert RIS → UKS L1
uks scaffold --from openapi <file>    Scaffold UKS L2 from OpenAPI spec
uks export   --format jsonld <file>   Export to schema.org JSON-LD
uks export   --format fhir  <file>    Export to FHIR R4 Bundle

uks serve  <file.uks.json>            Print Claude Desktop MCP config
uks serve  --start <file.uks.json>    Start MCP server over stdio

uks publish  [--key <k>] <file>       Publish packet to registry
uks search   [--level L1] <query>     Search the public registry
uks pull     [--out <file>] <id>      Download packet from registry
uks unpublish [--key <k>] <id>        Remove your packet

uks config set registry <url>         Set registry URL
uks config set api-key  <key>         Set API key
uks config generate-key               Generate a random API key

Quick Start

# Validate a packet
uks validate my-packet.uks.json

# Publish to the public registry
uks config set api-key uks_your_key_here
uks publish my-packet.uks.json

# Search the registry
uks search "omega-3 EPA DHA"

# Serve a packet as an MCP tool for Claude Desktop
uks serve my-packet.uks.json

UKS Format

A UKS packet bundles structured knowledge with evidence grades, license info, acquisition instructions, and agent directives into a single portable JSON file. Use the @uks/sdk to build packets programmatically.

{
  "packet_id": "uks-omega3-basics-v1",
  "schema_version": "3.0",
  "topic": "Omega-3 Fatty Acids",
  "conformance_level": "L1",
  "sources": [
    {
      "id": "src_001",
      "title": "Effect of EPA and DHA on cardiovascular risk",
      "source_type": "peer_reviewed",
      "credibility_score": 9,
      "evidence_grade": "high",
      "clinical_status": "validated"
    }
  ]
}

Links

• Specification
• TypeScript SDK (@uks/sdk)
• Python SDK (uks-sdk)
• MCP Server (@uks/mcp-server)
• Public Registry
• GitHub

License

MIT