@creator-notes/cli 0.2.0 → 0.2.2

package/.claude-plugin/plugin.json

@@ -0,0 +1,13 @@
+{
+  "name": "creator-notes-cli",
+  "version": "0.2.2",
+  "description": "CreatorNotes CLI — create notes, build canvases, search knowledge from the terminal",
+  "author": {
+    "name": "CreatorNotes",
+    "url": "https://creatornotes.app"
+  },
+  "repository": "https://github.com/creatornotes/pm-notes",
+  "license": "MIT",
+  "keywords": ["cli", "notes", "productivity", "pm", "canvas"],
+  "skills": "./skills/"
+}

package/README.md

@@ -0,0 +1,208 @@
+# @creator-notes/cli
+
+CLI for [CreatorNotes](https://creatornotes.app) — create notes, build canvases, search knowledge, and manage workspaces from the terminal.
+
+Works as a standalone CLI (`cn`) and as an MCP server (`cn-mcp`) for AI assistants like Claude.
+
+## Install
+
+```bash
+npm install -g @creator-notes/cli
+```
+
+## Quick Start
+
+```bash
+cn init                  # Interactive setup (auth + workspace)
+cn notes list            # Browse your notes
+cn notes create --markdown-file ./note.md --type "Meeting"
+cn search semantic "onboarding flow"
+```
+
+## Commands
+
+| Command | Alias | Description |
+|---------|-------|-------------|
+| `cn init` | | Interactive setup wizard |
+| `cn auth login` | | Authenticate via browser or API token |
+| `cn notes list\|get\|create\|update\|delete` | `cn n` | Manage notes |
+| `cn notes bulk-create` | | Create multiple interlinked notes atomically |
+| `cn versions list\|create` | `cn v` | Note version history |
+| `cn canvas list\|get\|create\|delete` | `cn c` | Manage canvases |
+| `cn canvas add-node\|add-text\|add-list\|add-link` | | Add nodes to canvas |
+| `cn canvas bulk-add\|bulk-move\|bulk-remove` | | Bulk canvas operations |
+| `cn canvas from-template` | | Create canvas from template |
+| `cn search semantic` | `cn s` | Semantic search across notes |
+| `cn timeline` | `cn tl` | Recent activity feed |
+| `cn relationships list` | `cn rel` | Note relationships |
+| `cn types list\|create\|update` | `cn t` | Manage note types (supertags) |
+| `cn memory query\|facts\|entities` | `cn mem` | Query workspace knowledge |
+| `cn workspace list\|select\|current` | | Workspace management |
+| `cn config get-server\|set-server` | | CLI configuration |
+| `cn mcp setup` | | Print MCP server config for Claude |
+
+## Global Flags
+
+```
+--json              Output raw JSON (for piping / scripting)
+-q, --quiet         Minimal output (IDs only)
+-w, --workspace <id>   Override active workspace
+--server <url>         Override server URL
+```
+
+## Authentication
+
+```bash
+# Browser-based OAuth (recommended)
+cn auth login
+
+# API token (CI / non-interactive)
+cn auth login --token <key>
+
+# Check session
+cn auth status
+```
+
+## Notes
+
+```bash
+# Create from markdown file
+cn notes create --markdown-file ./standup.md --title "Daily Standup" --type "Meeting"
+
+# Create with tags
+cn notes create --markdown "Quick idea" --type "Insight" --tags "ux,onboarding"
+
+# List with filters
+cn notes list --type Meeting --pinned --limit 10
+
+# Get by display ID
+cn notes get MEETING-42
+
+# Update metadata
+cn notes update MEETING-42 --pin --tags "important,q2"
+```
+
+### Content Updates
+
+Content and metadata are separate operations:
+
+```bash
+# Update content -> create a new version
+cn versions create MEETING-42 --description "Added action items" --markdown-file ./updated.md
+
+# Update metadata (title, tags, pin, archive)
+cn notes update MEETING-42 --title "New Title"
+```
+
+## Canvas
+
+Values in `<angle-brackets>` are placeholders — replace them with real IDs from your workspace.
+
+```bash
+# Create a canvas and add notes
+cn canvas create "Sprint Review"
+cn canvas bulk-add <canvasId> --notes '[{"noteId":"NOTE-1","x":100,"y":100},{"noteId":"NOTE-2","x":500,"y":100}]'
+cn canvas add-edge <canvasId> --source <nodeId> --target <nodeId> --label "blocks"
+
+# Create from template
+cn canvas from-template sprint-retrospective --populate
+```
+
+Available templates: `sprint-retrospective`, `swot-analysis`, `kanban-board`, `feature-prioritization`, `meeting-notes`, `product-roadmap`
+
+## AI Integration
+
+### Claude Code (Plugin — recommended)
+
+This package ships as a Claude Code plugin. Once installed, Claude learns the full `cn` command reference and can operate your workspace autonomously.
+
+```bash
+# Inside Claude Code, run:
+/plugin install @creator-notes/cli
+```
+
+That's it — the `cn` skill is now available in every conversation. Claude will use it whenever you ask about notes, canvases, or workspace tasks.
+
+### Claude Desktop (MCP Server)
+
+Add CreatorNotes as a tool server so Claude Desktop can read and write your notes directly.
+
+**1. Authenticate and select a workspace:**
+
+```bash
+cn init
+```
+
+**2. Generate the MCP config:**
+
+```bash
+cn mcp setup --json
+```
+
+**3. Copy the output into your Claude Desktop config file:**
+
+| OS | Config path |
+|----|-------------|
+| macOS | `~/Library/Application Support/Claude/claude_desktop_config.json` |
+| Windows | `%APPDATA%\Claude\claude_desktop_config.json` |
+| Linux | `~/.config/Claude/claude_desktop_config.json` |
+
+The output looks like this — merge it into your existing config:
+
+```json
+{
+  "mcpServers": {
+    "cn": {
+      "command": "node",
+      "args": ["/path/to/dist/mcp-server.js"],
+      "env": {
+        "CN_SERVER": "https://creatornotes.app",
+        "CN_TOKEN": "<your-token>",
+        "CN_WORKSPACE": "<your-workspace-id>"
+      }
+    }
+  }
+}
+```
+
+**4. Restart Claude Desktop.** The `cn` tools will appear in the tool picker.
+
+### Manual Skill Install
+
+If you're not using the plugin system, you can copy the skill file directly:
+
+```bash
+# Copy into your project
+mkdir -p .claude/skills/cn
+cp $(npm root -g)/@creator-notes/cli/skills/cn/SKILL.md .claude/skills/cn/SKILL.md
+
+# Or into your user-level skills (available everywhere)
+mkdir -p ~/.claude/skills/cn
+cp $(npm root -g)/@creator-notes/cli/skills/cn/SKILL.md ~/.claude/skills/cn/SKILL.md
+```
+
+## Scripting
+
+```bash
+# Chain commands with quiet mode
+NOTE_ID=$(cn notes create --markdown "Quick note" --type "Note" -q)
+cn canvas add-node <canvasId> --note "$NOTE_ID"
+
+# JSON output for parsing
+cn notes list --json | jq '.[0].displayId'
+
+# Bulk create interlinked notes with @key placeholders
+cn notes bulk-create --notes '[
+  {"key":"A","title":"Problem","type":"PainPoint","markdownFile":"./problem.md"},
+  {"key":"B","title":"Solution","type":"Insight","markdownFile":"./solution.md"}
+]' --json
+```
+
+## Requirements
+
+- Node.js >= 18
+- A [CreatorNotes](https://creatornotes.app) account
+
+## License
+
+MIT