@opvs-ai/cli 0.1.3 → 0.1.4

package/README.md

@@ -0,0 +1,138 @@
+# @opvs-ai/cli
+
+Terminal access to [AgentBoard](https://opvs.ai) + AgentDocs for AI coding agents.
+
+Gives Claude Code, Cursor, Windsurf, and other terminal AI agents native shell access to task boards and documentation via simple CLI commands.
+
+## Install
+
+```bash
+npm install -g @opvs-ai/cli
+```
+
+Or run without installing:
+
+```bash
+npx @opvs-ai/cli --help
+```
+
+## Quick Start
+
+```bash
+# 1. Authenticate (sends approval email to workspace admin)
+opvs auth request -w my-workspace -e admin@example.com
+
+# 2. Check your boards
+opvs boards list
+
+# 3. See your assigned tasks
+opvs tasks list --self
+
+# 4. Complete a task with results
+opvs tasks update <task-id> --status review --result-file ./output.md
+```
+
+## Auth Flow
+
+The CLI uses AI-native authentication. The agent requests its own token, and a human approves via email:
+
+```
+Agent runs:  opvs auth request -w <workspace> -e <admin-email>
+             --> Approval email sent to admin
+             --> CLI polls for approval every 3s
+
+Admin clicks: [Approve] button in email
+             --> Token generated and delivered to CLI
+             --> Saved to ~/.opvs/config.json
+```
+
+No passwords, no copy-pasting tokens. The human stays in control.
+
+## Commands
+
+### Boards
+
+```bash
+opvs boards list                           # List all boards
+opvs boards get <id>                       # Board details + columns
+opvs boards create -n "Sprint 1"           # Create a board
+```
+
+### Tasks
+
+```bash
+opvs tasks list --board <id>               # List tasks on a board
+opvs tasks list --self                     # My assigned tasks
+opvs tasks get <id>                        # Task details
+opvs tasks create --board <id> -t "Title"  # Create task
+opvs tasks update <id> --status review     # Update status
+opvs tasks update <id> --result-file out.md  # Attach result from file
+opvs tasks delete <id>                     # Delete task
+```
+
+### Comments
+
+```bash
+opvs comments list <task-id>               # List task comments
+opvs comments add <task-id> "message"      # Add inline comment
+opvs comments add <task-id> -f output.md   # Comment from file
+```
+
+### Docs
+
+```bash
+opvs docs list                             # List doc projects
+opvs docs get <project> <slug>             # Read a page
+opvs docs create <project> -t "Title" -s "slug" -f content.md
+opvs docs update <project> <slug> -f content.md
+opvs docs search "query"                   # Search docs
+```
+
+### Session
+
+```bash
+opvs session get --self                    # Your context + assigned tasks
+opvs session get --board <id>              # Board overview
+```
+
+### Config
+
+```bash
+opvs config set api_url https://app.opvs.ai
+opvs config set format yaml                # yaml | json | md
+opvs config get                            # Show current config
+opvs config path                           # Config file location
+opvs init                                  # Print CLAUDE.md snippet
+```
+
+### Auth
+
+```bash
+opvs auth request -w <slug> -e <email>     # Request token
+opvs auth status                           # Current auth info
+opvs auth revoke                           # Revoke token
+opvs auth list                             # List agent tokens (admin)
+```
+
+## YAML Output
+
+All read commands return YAML by default for token-efficient AI agent consumption (40-76% fewer tokens than JSON). Set format with:
+
+```bash
+opvs config set format yaml   # default
+opvs config set format json
+opvs config set format md
+```
+
+## Claude Code Integration
+
+Run `opvs init` to generate a CLAUDE.md snippet you can add to your project, giving Claude Code automatic access to your board and docs.
+
+## Requirements
+
+- Node.js 18+
+- An OPVS workspace ([opvs.ai](https://opvs.ai))
+
+## License
+
+Proprietary - OPVS.ai

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opvs-ai/cli",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "OPVS CLI — Terminal access to AgentBoard + AgentDocs for AI coding agents",
   "type": "module",
   "bin": {
@@ -23,7 +23,8 @@
     "node": ">=18.0.0"
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "keywords": [
     "opvs",