octocode-cli 1.0.0

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 (5) hide show
  1. package/LICENSE +63 -0
  2. package/README.md +147 -0
  3. package/assets/example.png +0 -0
  4. package/out/octocode-cli.js +3600 -0
  5. package/package.json +69 -0
package/LICENSE ADDED
@@ -0,0 +1,63 @@
1
+ # PolyForm Small Business License 1.0.0
2
+
3
+ <https://polyformproject.org/licenses/small-business/1.0.0>
4
+
5
+ ## Acceptance
6
+
7
+ To obtain any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
8
+
9
+ ## Copyright License
10
+
11
+ The licensor grants you a copyright license for the software to do everything you might do with the software that would otherwise infringe the licensor's copyright in it for any permitted purpose. However, you may only distribute the software according to the Distribution License and make changes or new works based on the software according to the Changes and New Works License.
12
+
13
+ ## Distribution License
14
+
15
+ The licensor grants you an additional copyright license to distribute copies of the software. Your license to distribute covers distributing the software with changes and new works permitted by the Changes and New Works License.
16
+
17
+ ## Notices
18
+
19
+ You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms or the URL for them above, as well as copies of any plain-text lines beginning with `Required Notice:` that the licensor provided with the software.
20
+
21
+ ## Changes and New Works License
22
+
23
+ The licensor grants you an additional copyright license to make changes and new works based on the software for any permitted purpose.
24
+
25
+ ## Patent License
26
+
27
+ The licensor grants you a patent license for the software that covers patent claims the licensor can license, or becomes able to license, that you would infringe by using the software.
28
+
29
+ ## Fair Use
30
+
31
+ You may have "fair use" rights for the software under the law. These terms do not limit them.
32
+
33
+ ## Small Business
34
+
35
+ Use of the software for the benefit of your company is use for a permitted purpose if your company has fewer than 100 total individuals working as employees and independent contractors, and less than 1,000,000 USD (2019) total revenue in the prior tax year. Revenue thresholds adjust for inflation according to the United States Bureau of Labor Statistics' consumer price index for all urban consumers, U.S. city average, for all items, not seasonally adjusted, with 1982–1984=100 reference base.
36
+
37
+ ## No Other Rights
38
+
39
+ These terms do not allow you to sublicense or transfer any of your licenses to anyone else, or prevent the licensor from granting licenses to anyone else. These terms do not imply any other licenses.
40
+
41
+ ## Patent Defense
42
+
43
+ If you make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
44
+
45
+ ## Violations
46
+
47
+ The first time you are notified in writing that you have violated any of these terms, or done anything with the software not covered by your licenses, your licenses can nonetheless continue if you come into full compliance with these terms, and take practical steps to correct past violations, within 32 days of receiving notice. Otherwise, all your licenses end immediately.
48
+
49
+ ## No Liability
50
+
51
+ The software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.
52
+
53
+ ## Definitions
54
+
55
+ The **licensor** is the individual or entity offering these terms, and the **software** is the software the licensor makes available under these terms.
56
+
57
+ **You** refers to the individual or entity agreeing to these terms.
58
+
59
+ **Your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. **Control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
60
+
61
+ **Your licenses** are all the licenses granted to you for the software under these terms.
62
+
63
+ **Use** means anything you do with the software requiring one of your licenses.
package/README.md ADDED
@@ -0,0 +1,147 @@
1
+ # 🐙 Octocode CLI
2
+
3
+ **The easiest way to set up [octocode-mcp](https://www.npmjs.com/package/octocode-mcp) for your AI coding assistant.**
4
+
5
+ One command. Interactive setup. Done in seconds.
6
+
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>
10
+
11
+ ## ⚡ Quick Start
12
+
13
+ ```bash
14
+ npx octocode-cli
15
+ ```
16
+
17
+ That's it! The interactive wizard will guide you through everything.
18
+
19
+ ## ✨ Features
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
25
+
26
+ ## 📦 Installation
27
+
28
+ ### Run Directly (Recommended)
29
+
30
+ No installation needed - just run:
31
+
32
+ ```bash
33
+ npx octocode-cli
34
+ ```
35
+
36
+ ### Global Install
37
+
38
+ For frequent use:
39
+
40
+ ```bash
41
+ npm install -g octocode-cli
42
+ octocode
43
+ ```
44
+
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
57
+
58
+ For automation or CI/CD, use CLI flags:
59
+
60
+ ```bash
61
+ # Install for Cursor using NPX method
62
+ octocode install --ide cursor --method npx
63
+
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
72
+ ```
73
+
74
+ ### Commands
75
+
76
+ | Command | Description |
77
+ |---------|-------------|
78
+ | `install` | Install octocode-mcp for an IDE |
79
+ | `auth` | Check GitHub CLI authentication status |
80
+
81
+ ### Options
82
+
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 |
90
+
91
+ ## 📁 Configuration Files
92
+
93
+ The CLI automatically updates the correct config file for each IDE:
94
+
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 |
103
+
104
+ ## 🔐 GitHub Authentication
105
+
106
+ Octocode uses GitHub CLI (`gh`) for secure authentication:
107
+
108
+ ```bash
109
+ # Check your auth status
110
+ octocode auth
111
+
112
+ # Install GitHub CLI if needed
113
+ # macOS
114
+ brew install gh
115
+
116
+ # Windows
117
+ winget install GitHub.cli
118
+
119
+ # Then authenticate
120
+ gh auth login
121
+ ```
122
+
123
+ ## 📋 Requirements
124
+
125
+ - **Node.js** >= 18.0.0
126
+ - **GitHub CLI** (recommended for best experience)
127
+
128
+ ## 🔧 Troubleshooting
129
+
130
+ If you encounter issues with Node.js or npm, run the following command to diagnose problems:
131
+
132
+ ```bash
133
+ npx node-doctor
134
+ ```
135
+
136
+ This will check your Node.js environment and help identify common issues with your installation.
137
+
138
+ ## 🔗 Links
139
+
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)
144
+
145
+ ## 📄 License
146
+
147
+ PolyForm-Small-Business-1.0.0
package/assets/example.png ADDED
Binary file