octocode-cli 1.0.0 → 1.1.1

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 (10) hide show
  1. package/README.md +93 -93
  2. package/out/octocode-cli.js +9818 -1626
  3. package/package.json +15 -6
  4. package/skills/README.md +121 -0
  5. package/skills/octocode-generate/SKILL.md +166 -0
  6. package/skills/octocode-plan/SKILL.md +166 -0
  7. package/skills/octocode-pr-review/SKILL.md +137 -0
  8. package/skills/octocode-research/SKILL.md +177 -0
  9. package/skills/octocode-research/references/tool-reference.md +304 -0
  10. package/skills/octocode-research/references/workflow-patterns.md +325 -0
package/README.md CHANGED
@@ -1,147 +1,147 @@
1
1
  # 🐙 Octocode CLI
2
2
 
3
- **The easiest way to set up [octocode-mcp](https://www.npmjs.com/package/octocode-mcp) for your AI coding assistant.**
3
+ <div align="center">
4
4
 
5
- One command. Interactive setup. Done in seconds.
5
+ [![npm version](https://img.shields.io/npm/v/octocode-cli.svg?style=flat-square)](https://www.npmjs.com/package/octocode-cli)
6
+ [![npm downloads](https://img.shields.io/npm/dm/octocode-cli.svg?style=flat-square)](https://www.npmjs.com/package/octocode-cli)
7
+ [![License](https://img.shields.io/badge/license-PolyForm--Small--Business-blue.svg?style=flat-square)](LICENSE)
6
8
 
7
- <p align="center">
8
- <img src="https://raw.githubusercontent.com/bgauryy/octocode-mcp/main/packages/octocode-cli/assets/example.png" alt="Octocode CLI" width="700">
9
- </p>
9
+ **The unified installer and management hub for Octocode MCP servers and AI skills.**
10
10
 
11
- ## ⚡ Quick Start
11
+ [Website](https://octocode.ai) • [Documentation](https://docs.octocode.ai) • [GitHub](https://github.com/bgauryy/octocode-mcp)
12
12
 
13
- ```bash
14
- npx octocode-cli
15
- ```
13
+ <img src="https://raw.githubusercontent.com/bgauryy/octocode-mcp/main/packages/octocode-cli/assets/example.png" alt="Octocode CLI Demo" width="700" style="border-radius: 8px; margin: 20px 0;">
14
+
15
+ </div>
16
16
 
17
- That's it! The interactive wizard will guide you through everything.
17
+ **Octocode CLI** is the essential companion for AI-assisted development. It streamlines the installation of [octocode-mcp](https://www.npmjs.com/package/octocode-mcp), manages authentication across multiple AI clients, and keeps your MCP configurations synchronized.
18
18
 
19
- ## ✨ Features
19
+ ---
20
20
 
21
- - 🎯 **Zero Config** - Interactive prompts handle everything
22
- - 🔍 **Auto-Detection** - Finds installed IDEs automatically
23
- - ✅ **Environment Check** - Validates Node.js, npm & GitHub CLI
24
- - 🛡️ **Safe Updates** - Preserves existing MCP configurations
21
+ ## ✨ Key Features
25
22
 
26
- ## 📦 Installation
23
+ - **🚀 One-Step Installation**: Instantly configure `octocode-mcp` for Cursor, Claude Desktop, Windsurf, Zed, and more.
24
+ - **🔌 MCP Marketplace**: Browse and install over 70+ community-vetted MCP servers directly from your terminal.
25
+ - **🧠 AI Skills Manager**: Install and update specialized AI coding skills for Claude Code (`research`, `plan`, `pr-review`).
26
+ - **🔄 Universal Sync**: Keep your MCP configurations and authentication states synchronized across all your IDEs.
27
+ - **🔐 Secure Authentication**: Enterprise-grade token management with encrypted storage and multiple auth providers.
27
28
 
28
- ### Run Directly (Recommended)
29
+ ---
29
30
 
30
- No installation needed - just run:
31
+ ## 🚀 Quick Start
32
+
33
+ Get up and running in seconds. The interactive wizard will guide you through installation and authentication.
31
34
 
32
35
  ```bash
33
36
  npx octocode-cli
34
37
  ```
35
38
 
36
- ### Global Install
39
+ ---
40
+
41
+ ## 📦 Installation & Usage
37
42
 
38
- For frequent use:
43
+ ### Interactive Mode
44
+ The recommended way to use Octocode CLI. Access all features through a unified menu:
45
+ - **Octocode Configuration**: Setup MCP servers and GitHub auth.
46
+ - **Manage System Skills**: Install AI capabilities.
47
+ - **Manage System MCP**: Sync configs and browse the marketplace.
39
48
 
40
49
  ```bash
41
- npm install -g octocode-cli
42
- octocode
50
+ npx octocode-cli
43
51
  ```
44
52
 
45
- ## 🖥️ Supported Clients
46
-
47
- | Client | Description | Status |
48
- |--------|-------------|--------|
49
- | **Cursor** | AI-first code editor | ✅ Supported |
50
- | **Claude Desktop** | Anthropic's desktop app | ✅ Supported |
51
- | **Claude Code** | Claude CLI for terminal | ✅ Supported |
52
- | **Windsurf** | Codeium AI IDE | ✅ Supported |
53
- | **Zed** | High-performance editor | ✅ Supported |
54
- | **Cline** | VS Code AI extension | ✅ Supported |
55
-
56
- ## 🔧 CLI Mode
53
+ ### CLI Commands
54
+ For automation and power users, Octocode CLI offers a comprehensive command-line interface.
57
55
 
58
- For automation or CI/CD, use CLI flags:
56
+ #### 1. Install Octocode MCP
57
+ Install the GitHub MCP server for your preferred IDE.
59
58
 
60
59
  ```bash
61
- # Install for Cursor using NPX method
62
- octocode install --ide cursor --method npx
60
+ # Interactive install
61
+ octocode-cli install
63
62
 
64
- # Install for Claude Desktop
65
- octocode install --ide claude --method direct
66
-
67
- # Force overwrite existing config
68
- octocode install --ide cursor --method npx --force
69
-
70
- # Check GitHub authentication
71
- octocode auth
63
+ # Specific IDEs
64
+ octocode-cli install --ide cursor --method npx
65
+ octocode-cli install --ide claude-desktop --method direct
66
+ octocode-cli install --ide windsurf
72
67
  ```
73
68
 
74
- ### Commands
75
-
76
- | Command | Description |
77
- |---------|-------------|
78
- | `install` | Install octocode-mcp for an IDE |
79
- | `auth` | Check GitHub CLI authentication status |
69
+ #### 2. Manage Authentication
70
+ Securely authenticate with GitHub. Credentials are encrypted (AES-256-GCM) and stored in `~/.octocode/`.
80
71
 
81
- ### Options
72
+ ```bash
73
+ # Interactive login
74
+ octocode-cli login
82
75
 
83
- | Option | Description |
84
- |--------|-------------|
85
- | `--ide <ide>` | IDE to configure: `cursor`, `claude`, `claude-code`, `windsurf`, `zed`, `cline` |
86
- | `--method <method>` | Installation method: `npx` or `direct` |
87
- | `-f, --force` | Overwrite existing configuration |
88
- | `-h, --help` | Show help message |
89
- | `-v, --version` | Show version number |
76
+ # Check status
77
+ octocode-cli status
90
78
 
91
- ## 📁 Configuration Files
79
+ # Enterprise Login
80
+ octocode-cli login --hostname github.mycompany.com
81
+ ```
92
82
 
93
- The CLI automatically updates the correct config file for each IDE:
83
+ #### 3. Sync Configurations
84
+ Keep your MCP settings consistent across different editors.
94
85
 
95
- | IDE | macOS | Windows |
96
- |-----|-------|---------|
97
- | Cursor | `~/.cursor/mcp.json` | `%APPDATA%\Cursor\mcp.json` |
98
- | Claude Desktop | `~/Library/Application Support/Claude/claude_desktop_config.json` | `%APPDATA%\Claude\claude_desktop_config.json` |
99
- | Claude Code | `~/.claude.json` | `%USERPROFILE%\.claude.json` |
100
- | Windsurf | `~/.codeium/windsurf/mcp_config.json` | `%APPDATA%\Codeium\windsurf\mcp_config.json` |
101
- | Zed | `~/.config/zed/settings.json` | `%APPDATA%\Zed\settings.json` |
102
- | Cline | VS Code settings | VS Code settings |
86
+ ```bash
87
+ # Sync all IDEs
88
+ octocode-cli sync
103
89
 
104
- ## 🔐 GitHub Authentication
90
+ # Preview changes
91
+ octocode-cli sync --dry-run
92
+ ```
105
93
 
106
- Octocode uses GitHub CLI (`gh`) for secure authentication:
94
+ #### 4. Manage Skills
95
+ Install AI skills for Claude Code.
107
96
 
108
97
  ```bash
109
- # Check your auth status
110
- octocode auth
98
+ # List available skills
99
+ octocode-cli skills list
111
100
 
112
- # Install GitHub CLI if needed
113
- # macOS
114
- brew install gh
101
+ # Install all standard skills
102
+ octocode-cli skills install
103
+ ```
115
104
 
116
- # Windows
117
- winget install GitHub.cli
105
+ ---
118
106
 
119
- # Then authenticate
120
- gh auth login
121
- ```
107
+ ## 🖥️ Supported Clients
108
+
109
+ Octocode CLI supports a wide range of AI-first editors and tools.
122
110
 
123
- ## 📋 Requirements
111
+ | Client | Description | Config Location (macOS) |
112
+ |--------|-------------|-------------------------|
113
+ | **Cursor** | AI-first code editor | `~/.cursor/mcp.json` |
114
+ | **Claude Desktop** | Anthropic's desktop app | `~/Library/Application Support/Claude/` |
115
+ | **Windsurf** | Codeium AI IDE | `~/.codeium/windsurf/mcp_config.json` |
116
+ | **Zed** | High-performance editor | `~/.config/zed/settings.json` |
117
+ | **Claude Code** | CLI Assistant | `~/.claude.json` |
118
+ | **VS Code Extensions** | Cline, Roo-Cline, Continue | *(Varies by extension)* |
124
119
 
125
- - **Node.js** >= 18.0.0
126
- - **GitHub CLI** (recommended for best experience)
120
+ ---
127
121
 
128
122
  ## 🔧 Troubleshooting
129
123
 
130
- If you encounter issues with Node.js or npm, run the following command to diagnose problems:
124
+ If you encounter issues, try the following commands:
131
125
 
132
126
  ```bash
127
+ # Diagnose environment issues
133
128
  npx node-doctor
134
- ```
135
129
 
136
- This will check your Node.js environment and help identify common issues with your installation.
130
+ # Reset local credentials
131
+ rm -rf ~/.octocode && octocode-cli login
137
132
 
138
- ## 🔗 Links
133
+ # Verify auth status
134
+ octocode-cli status
135
+ ```
136
+
137
+ **Common Issues:**
138
+ - **Token Expired**: Run `octocode-cli login` to refresh credentials.
139
+ - **Browser Not Opening**: Copy the authorization URL manually from the terminal.
139
140
 
140
- - [Octocode Website](https://octocode.ai)
141
- - [octocode-cli on NPM](https://www.npmjs.com/package/octocode-cli)
142
- - [octocode-mcp on NPM](https://www.npmjs.com/package/octocode-mcp)
143
- - [GitHub Repository](https://github.com/bgauryy/octocode-mcp)
141
+ ---
144
142
 
145
143
  ## 📄 License
146
144
 
147
- PolyForm-Small-Business-1.0.0
145
+ This project is licensed under the **PolyForm Small Business License 1.0.0**.
146
+
147
+ Copyright © 2024 Octocode AI.