@runcontext/cli 0.3.3 → 0.3.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +108 -0
  3. package/package.json +9 -9
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Eric Kittelson
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,108 @@
1
+ # @runcontext/cli
2
+
3
+ CLI for [ContextKit](https://github.com/erickittelson/ContextKit) — AI-ready metadata governance over OSI.
4
+
5
+ **Your data already has a schema. ContextKit gives it meaning.**
6
+
7
+ ## Installation
8
+
9
+ ```bash
10
+ # Global install
11
+ npm install -g @runcontext/cli
12
+
13
+ # Or per-project
14
+ npm install -D @runcontext/cli
15
+ ```
16
+
17
+ ## Quick Start
18
+
19
+ ```bash
20
+ # Point at any database — interactive wizard does the rest
21
+ context setup
22
+
23
+ # Or step by step
24
+ context introspect --db duckdb://warehouse.duckdb
25
+ context enrich --target silver --apply
26
+ context tier
27
+ ```
28
+
29
+ ## Commands
30
+
31
+ ### Core Workflow
32
+
33
+ ```bash
34
+ context setup # Interactive wizard — database to metadata in one flow
35
+ context introspect # Scan a database → scaffold Bronze-level OSI metadata
36
+ context enrich --target silver # Auto-enrich metadata toward a target tier
37
+ context lint # Run 37 lint rules against context files
38
+ context fix --write # Auto-fix lint issues where possible
39
+ context build # Compile context files → emit manifest JSON
40
+ context tier [model] # Show Bronze/Silver/Gold scorecard
41
+ ```
42
+
43
+ ### Exploration
44
+
45
+ ```bash
46
+ context explain <name> # Look up any model, term, or owner
47
+ context rules # List all lint rules with tier, severity, fixability
48
+ context validate-osi <file> # Validate a single OSI file against the schema
49
+ context verify # Check metadata accuracy against a live database
50
+ ```
51
+
52
+ ### Serving
53
+
54
+ ```bash
55
+ context serve --stdio # Start MCP server over stdio (for Claude, Cursor, etc.)
56
+ context serve --http --port 3000 # Start MCP server over HTTP
57
+ context site # Generate a static documentation site
58
+ context dev # Watch mode — re-lint on file changes
59
+ context init # Scaffold a new project structure
60
+ ```
61
+
62
+ ## The Tier System
63
+
64
+ | Tier | What it means | How to get there |
65
+ |---|---|---|
66
+ | **Bronze** | Discoverable — described, owned, classified | `context introspect` |
67
+ | **Silver** | Trusted — lineage, glossary, sample values, trust status | `context enrich --target silver` |
68
+ | **Gold** | AI-Ready — semantic roles, golden queries, guardrails, business rules | Human curation + `context enrich --target gold` |
69
+
70
+ ## Database Support
71
+
72
+ | Adapter | Connection |
73
+ |---|---|
74
+ | DuckDB | `--db duckdb://path/to/file.duckdb` |
75
+ | PostgreSQL | `--db postgres://user:pass@host:5432/db` |
76
+
77
+ ## MCP Server
78
+
79
+ Expose your metadata to AI agents:
80
+
81
+ ```bash
82
+ # For Claude Code / Cursor
83
+ context serve --stdio
84
+
85
+ # For multi-agent setups
86
+ context serve --http --port 3000
87
+ ```
88
+
89
+ Add to `.claude/mcp.json`:
90
+
91
+ ```json
92
+ {
93
+ "mcpServers": {
94
+ "contextkit": {
95
+ "command": "npx",
96
+ "args": ["@runcontext/cli", "serve", "--stdio"]
97
+ }
98
+ }
99
+ }
100
+ ```
101
+
102
+ ## Full Documentation
103
+
104
+ See the [ContextKit repository](https://github.com/erickittelson/ContextKit) for complete docs, file structure, tier requirements, and examples.
105
+
106
+ ## License
107
+
108
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@runcontext/cli",
3
- "version": "0.3.3",
3
+ "version": "0.3.4",
4
4
  "description": "CLI for ContextKit — lint, build, fix, and serve institutional context",
5
5
  "license": "MIT",
6
6
  "author": "Eric Kittelson",
@@ -25,14 +25,10 @@
25
25
  "files": [
26
26
  "dist"
27
27
  ],
28
- "scripts": {
29
- "build": "tsup",
30
- "clean": "rm -rf dist"
31
- },
32
28
  "dependencies": {
33
- "@runcontext/core": "^0.3.3",
34
- "@runcontext/mcp": "^0.3.3",
35
- "@runcontext/site": "^0.3.3",
29
+ "@runcontext/core": "^0.3.4",
30
+ "@runcontext/mcp": "^0.3.4",
31
+ "@runcontext/site": "^0.3.4",
36
32
  "chalk": "^5.4.0",
37
33
  "chokidar": "^4.0.0",
38
34
  "commander": "^14.0.0",
@@ -44,5 +40,9 @@
44
40
  "tsup": "^8.4.0",
45
41
  "typescript": "^5.7.0",
46
42
  "vitest": "^3.2.0"
43
+ },
44
+ "scripts": {
45
+ "build": "tsup",
46
+ "clean": "rm -rf dist"
47
47
  }
48
- }
48
+ }