@contextium/cli 1.0.26 → 1.0.27

package/README.md

@@ -1,14 +1,29 @@
 # Contextium CLI
 
-CLI for managing Contextium workspaces, context libraries, files, workflows, agents, skills, tags, and marketplace installs.
+[![npm version](https://img.shields.io/npm/v/@contextium/cli.svg)](https://www.npmjs.com/package/@contextium/cli)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Command-line tool for managing Contextium — your team's AI knowledge store. Create and manage context libraries, agents, skills, workflows, and tags from the terminal. Pipe your team's documentation directly into Claude, Cursor, Copilot, and any other AI coding assistant.
+
+## What is Contextium?
+
+Contextium is a central file system for team knowledge that AI assistants can read directly. Use it to store:
+
+- **Coding standards** and style guides your AI should always follow
+- **SOPs** for onboarding, deployments, incident response
+- **AI agent configs** — pre-configured assistants with defined roles and skills
+- **Workflows** — bundles of context that load in one command
+- **Tags** for organising and searching across all your documentation
+
+The CLI lets you manage all of this from your terminal and pipe content into any AI workflow.
 
 ## Install
 
 ```bash
-npm i -g @contextium/cli
+npm install -g @contextium/cli
 ```
 
-Or run without installing globally:
+Or run without installing:
 
 ```bash
 npx @contextium/cli --help
@@ -17,133 +32,227 @@ npx @contextium/cli --help
 ## Quick Start
 
 ```bash
-# 1) Sign in
+# 1. Authenticate
 contextium login
 
-# 2) Optional guided setup
-contextium setup
-
-# 3) See your workspaces
+# 2. See your workspaces
 contextium workspaces
 
-# 4) List context libraries in a workspace
+# 3. List context libraries
 contextium libraries -w my-workspace
 
-# 5) Find and read files
-contextium find auth -w my-workspace
-contextium cat README.md -w my-workspace
+# 4. Pull all content into your clipboard (pipe to Claude, Cursor, etc.)
+contextium cat --all -w my-workspace | pbcopy
+
+# 5. Find a specific file
+contextium find "authentication" -w my-workspace
 ```
 
-## Command Groups
+## Connect to Claude and Cursor
+
+The CLI pairs with the [Contextium MCP server](https://www.npmjs.com/package/@contextium/mcp-server) so Claude and Cursor can read your workspace automatically.
+
+**Quickest setup:**
+
+```bash
+contextium setup-claude
+```
+
+This writes the MCP config to `~/Library/Application Support/Claude/claude_desktop_config.json` for you. Restart Claude Desktop and your team's docs are live in Claude.
+
+Or connect via the hosted remote MCP (no local install needed):
+
+```json
+{
+  "mcpServers": {
+    "contextium": {
+      "type": "sse",
+      "url": "https://mcp.contextium.io/sse"
+    }
+  }
+}
+```
+
+## Commands
 
 ### Auth
 
-- `contextium login`
-- `contextium logout`
-- `contextium whoami`
+```bash
+contextium login           # Authenticate with your Contextium account
+contextium logout          # Sign out
+contextium whoami          # Show current user and workspace
+```
 
 ### Setup
 
-- `contextium setup`
-- `contextium init`
-- `contextium setup-claude`
+```bash
+contextium setup           # Guided interactive setup
+contextium init            # Initialise Contextium in current project
+contextium setup-claude    # Auto-write Claude Desktop MCP config
+```
 
-### Workspace and Libraries
+### Workspaces and Libraries
 
-- `contextium workspaces`
-- `contextium libraries -w <workspace>`
-- `contextium create-library -w <workspace> -n "Docs"`
-- `contextium update-library <libraryId> -n "New Name"`
+```bash
+contextium workspaces                                  # List workspaces
+contextium libraries -w <workspace>                    # List context libraries
+contextium create-library -w <workspace> -n "Docs"    # Create a library
+contextium update-library <libraryId> -n "New Name"   # Rename a library
+```
 
 ### Files and Content
 
-- `contextium files <library> -w <workspace>`
-- `contextium new <library> -t "Guide" -p guide.md -w <workspace>`
-- `contextium edit <fileId> -c "Updated content" -m "Update summary"`
-- `contextium delete <fileId> --confirm`
-- `contextium versions <fileId>`
-- `contextium structure <library> -w <workspace>`
-- `contextium cat --all -w <workspace>`
-- `contextium sync -w <workspace>`
-- `contextium status -w <workspace>`
+```bash
+# List and browse
+contextium files <library> -w <workspace>              # List files in a library
+contextium structure <library> -w <workspace>          # Show folder tree
+contextium cat <fileId> -w <workspace>                 # Read a file
+contextium cat --all -w <workspace>                    # Dump all files (pipe to AI)
+
+# Create and edit
+contextium new <library> -t "Title" -p path.md -w <workspace>   # Create file
+contextium edit <fileId> -c "Updated content" -m "summary"      # Update file
+contextium delete <fileId> --confirm                             # Delete (trash)
+
+# Version history
+contextium versions <fileId>
+
+# Sync local cache
+contextium sync -w <workspace>
+contextium status -w <workspace>
+```
 
 ### Search
 
-- `contextium search "authentication" -w <workspace>`
-- `contextium find "api" -w <workspace>`
+```bash
+contextium search "authentication flow" -w <workspace>   # Full-text search
+contextium find "api" -w <workspace>                     # Find files by name/content
+```
 
 ### Tags
 
-- `contextium tags types -w <workspace>`
-- `contextium tags create-type -w <workspace> -n "Topic"`
-- `contextium tags list -w <workspace>`
-- `contextium tags create -w <workspace> --type <typeId> --value authentication`
-- `contextium tags apply -w <workspace> --tag topic:authentication --file <fileId>`
-- `contextium tags apply-bulk -w <workspace> --tag <tagId> --files <file1,file2>`
-- `contextium tags remove -w <workspace> --tag <tagId> --file <fileId>`
-- `contextium tags search -w <workspace> --tags topic:authentication`
-- `contextium tags file-tags -w <workspace> --file <fileId>`
-- `contextium tags update -w <workspace> --tag <tagId> --value auth`
-- `contextium tags type-get -w <workspace> --type <typeId>`
-- `contextium tags type-update -w <workspace> --type <typeId> --name "Topic"`
+```bash
+# Tag types (categories)
+contextium tags types -w <workspace>
+contextium tags create-type -w <workspace> -n "Topic"
+contextium tags type-get -w <workspace> --type <typeId>
+contextium tags type-update -w <workspace> --type <typeId> --name "Topic"
+
+# Tags
+contextium tags list -w <workspace>
+contextium tags create -w <workspace> --type <typeId> --value authentication
+contextium tags update -w <workspace> --tag <tagId> --value auth
+
+# Apply / remove
+contextium tags apply -w <workspace> --tag topic:authentication --file <fileId>
+contextium tags apply-bulk -w <workspace> --tag <tagId> --files <file1,file2>
+contextium tags remove -w <workspace> --tag <tagId> --file <fileId>
+
+# Search by tags
+contextium tags search -w <workspace> --tags topic:authentication
+contextium tags file-tags -w <workspace> --file <fileId>
+```
 
 ### Agents and Skills
 
-- `contextium agents list -w <workspace>`
-- `contextium agents create -w <workspace> -n "Code Reviewer"`
-- `contextium agents add-skill -w <workspace> --agent <agentId> --skill <skillId>`
-- `contextium agents remove-skill -w <workspace> --agent <agentId> --skill <skillId>`
-- `contextium agents update -w <workspace> --agent <agentId> --name "Reviewer"`
-- `contextium skills list -w <workspace>`
-- `contextium skills create -w <workspace> -n "API Patterns"`
+```bash
+# Agents — AI assistants with defined roles
+contextium agents list -w <workspace>
+contextium agents create -w <workspace> -n "Code Reviewer"
+contextium agents update -w <workspace> --agent <agentId> --name "Reviewer"
+contextium agents add-skill -w <workspace> --agent <agentId> --skill <skillId>
+contextium agents remove-skill -w <workspace> --agent <agentId> --skill <skillId>
+
+# Skills — reusable knowledge blocks
+contextium skills list -w <workspace>
+contextium skills create -w <workspace> -n "API Patterns"
+```
 
 ### Workflows
 
-- `contextium workflows list -w <workspace>`
-- `contextium workflows create -w <workspace> -n "Backend Task"`
-- `contextium workflows update -w <workspace> --id <workflowId> --name "Backend Delivery"`
-- `contextium workflow "Backend Task" -w <workspace>`
+```bash
+contextium workflows list -w <workspace>
+contextium workflows create -w <workspace> -n "Backend Task"
+contextium workflows update -w <workspace> --id <workflowId> --name "Backend Delivery"
+
+# Load a workflow — returns all associated agents, skills, and files
+contextium workflow "Backend Task" -w <workspace>
+```
 
 ### Marketplace
 
-- `contextium marketplace list`
-- `contextium marketplace list --type skill --category backend`
-- `contextium marketplace show code-review-assistant`
-- `contextium marketplace install code-review-assistant -w <workspace>`
+```bash
+contextium marketplace list                                        # Browse all listings
+contextium marketplace list --type skill --category backend        # Filter
+contextium marketplace show code-review-assistant                  # View details
+contextium marketplace install code-review-assistant -w <workspace> # Install
+```
 
 ## Global Flags
 
-- `-w, --workspace <name|slug|id>`: workspace selector for workspace-scoped commands
-- `-h, --help`: show command help
-- `-V, --version`: show CLI version
+| Flag | Description |
+|------|-------------|
+| `-w, --workspace <name\|slug\|id>` | Workspace selector |
+| `-h, --help` | Show command help |
+| `-V, --version` | Show CLI version |
 
-Run `contextium <command> --help` for command-specific flags.
+Run `contextium <command> --help` for command-specific options.
 
-## Typical Workflow
+## Example Workflows
 
-```bash
-# Authenticate and inspect available resources
-contextium login
-contextium workspaces
-contextium libraries -w my-workspace
+### Pipe team docs into an AI prompt
 
-# Pull context into your AI workflow
+```bash
+# Get all docs and copy to clipboard
 contextium cat --all -w my-workspace | pbcopy
 
-# Create and evolve content
-contextium new my-library -t "Runbook" -p runbook.md -w my-workspace
-contextium edit <fileId> -c "Updated runbook content" -m "refresh steps"
+# Get just a specific library
+contextium cat --all -w my-workspace -l coding-standards | pbcopy
+
+# Search and pipe results
+contextium search "deployment process" -w my-workspace
+```
+
+### Set up a new team member
+
+```bash
+# Authenticate
+contextium login
+
+# See what's available
+contextium workspaces
+contextium libraries -w acme-corp
 
-# Organize with tags
-contextium tags create-type -w my-workspace -n "Topic"
-contextium tags create -w my-workspace --type <typeId> --value reliability
-contextium tags apply -w my-workspace --tag topic:reliability --file <fileId>
+# Load the onboarding workflow
+contextium workflow "Onboarding" -w acme-corp
 ```
 
-## Development
+### Organise docs with tags
 
 ```bash
-npm run build
-npm run dev
-npm run type-check
+# Create a tag type
+contextium tags create-type -w my-workspace -n "Topic" --slug topic
+
+# Create tags
+contextium tags create -w my-workspace --type <typeId> --value authentication
+contextium tags create -w my-workspace --type <typeId> --value deployment
+
+# Tag files
+contextium tags apply -w my-workspace --tag topic:authentication --file <fileId>
+
+# Find all authentication files
+contextium tags search -w my-workspace --tags topic:authentication
 ```
+
+## Links
+
+- **Website**: https://contextium.io
+- **Documentation**: https://contextium.io/docs/cli
+- **MCP Server**: https://www.npmjs.com/package/@contextium/mcp-server
+- **Remote MCP**: https://mcp.contextium.io
+- **GitHub**: https://github.com/tomjutla/contextium
+- **Support**: support@contextium.io
+
+## License
+
+MIT © Contextium

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contextium/cli",
-  "version": "1.0.26",
+  "version": "1.0.27",
   "description": "Command-line tool for managing Contextium documentation, agents, skills, and workflows — pipe context to AI coding assistants",
   "keywords": [
     "contextium",
@@ -23,6 +23,10 @@
   ],
   "author": "Contextium",
   "license": "MIT",
+  "funding": {
+    "type": "commercial",
+    "url": "https://contextium.io/pricing"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/tomjutla/contextium.git",