octocode-cli 1.2.5 → 1.2.7

package/LICENSE

@@ -1,63 +1,21 @@
-# PolyForm Small Business License 1.0.0
-
-<https://polyformproject.org/licenses/small-business/1.0.0>
-
-## Acceptance
-
-To obtain any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
-
-## Copyright License
-
-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.
-
-## Distribution License
-
-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.
-
-## Notices
-
-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.
-
-## Changes and New Works License
-
-The licensor grants you an additional copyright license to make changes and new works based on the software for any permitted purpose.
-
-## Patent License
-
-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.
-
-## Fair Use
-
-You may have "fair use" rights for the software under the law. These terms do not limit them.
-
-## Small Business
-
-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.
-
-## No Other Rights
-
-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.
-
-## Patent Defense
-
-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.
-
-## Violations
-
-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.
-
-## No Liability
-
-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.
-
-## Definitions
-
-The **licensor** is the individual or entity offering these terms, and the **software** is the software the licensor makes available under these terms.
-
-**You** refers to the individual or entity agreeing to these terms.
-
-**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.
-
-**Your licenses** are all the licenses granted to you for the software under these terms.
-
-**Use** means anything you do with the software requiring one of your licenses.
+MIT License
+
+Copyright (c) 2026 Guy Bary
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,164 +1,141 @@
-# 🐙 Octocode CLI
+# Octocode CLI
 
 <div align="center">
 
 [![npm version](https://img.shields.io/npm/v/octocode-cli.svg?style=flat-square)](https://www.npmjs.com/package/octocode-cli)
 [![npm downloads](https://img.shields.io/npm/dm/octocode-cli.svg?style=flat-square)](https://www.npmjs.com/package/octocode-cli)
-[![License](https://img.shields.io/badge/license-PolyForm--Small--Business-blue.svg?style=flat-square)](LICENSE)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/bgauryy/octocode-mcp/blob/main/packages/octocode-cli/LICENSE)
 
-**The unified installer and management hub for Octocode MCP servers and AI skills.**
+**Installer and management CLI for Octocode MCP servers and AI skills.**
 
-[Website](https://octocode.ai) • [Documentation](https://docs.octocode.ai) • [GitHub](https://github.com/bgauryy/octocode-mcp)
+[Website](https://octocode.ai) | [Documentation](https://github.com/bgauryy/octocode-mcp/blob/main/docs/README.md) | [GitHub](https://github.com/bgauryy/octocode-mcp)
 
 <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;">
 
 </div>
 
-**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.
+Octocode CLI configures [octocode-mcp](https://www.npmjs.com/package/octocode-mcp) across AI editors, manages GitHub authentication, synchronizes MCP configs, and installs AI skills.
 
 ---
 
-## ✨ Key Features
+## Features
 
-- **🚀 One-Step Installation**: Instantly configure `octocode-mcp` for Cursor, Claude Desktop, Windsurf, Zed, and more.
-- **🔌 MCP Marketplace**: Browse and install over 70+ community-vetted MCP servers directly from your terminal.
-- **🧠 AI Skills Manager**: Install and update specialized AI coding skills for Claude Code (`research`, `local-search`, `implement`, `plan`, `pr-review`, `roast`).
-- **🔄 Universal Sync**: Keep your MCP configurations and authentication states synchronized across all your IDEs.
-- **🔐 Secure Authentication**: Enterprise-grade token management with encrypted storage and multiple auth providers.
+- **MCP installation** — configure `octocode-mcp` for Cursor, Claude Desktop, Windsurf, Zed, Claude Code, Trae, Antigravity, Opencode, and VS Code extensions (Cline, Roo-Cline, Continue).
+- **MCP marketplace** — browse and install 70+ community MCP servers from the terminal.
+- **Skills manager** — install 9 bundled `octocode-*` skills across clients (Claude Code, Claude Desktop, Cursor, Codex, Opencode). Supports single-skill, multi-target, copy, and symlink modes.
+- **Config sync** — keep MCP configurations consistent across all IDEs.
+- **Authentication** — GitHub OAuth device flow with AES-256-GCM encrypted token storage; supports Octocode OAuth, `gh` CLI, and env-var tokens.
+- **Cache management** — inspect and clean cloned-repo cache, skills marketplace cache, and logs.
 
 ---
 
-## 🚀 Quick Start
-
-Get up and running in seconds. The interactive wizard will guide you through installation and authentication.
+## Quick Start
 
 ```bash
 npx octocode-cli
 ```
 
----
-
-## 📦 Installation & Usage
-
-### Interactive Mode
-The recommended way to use Octocode CLI. Access all features through a unified menu:
-- **Octocode Configuration**: Setup MCP servers and GitHub auth.
-- **Manage System Skills**: Install AI capabilities.
-- **Manage System MCP**: Sync configs and browse the marketplace.
+The interactive menu covers MCP setup, skills, auth, and sync. For non-interactive use, see the [CLI Reference](https://github.com/bgauryy/octocode-mcp/blob/main/packages/octocode-cli/docs/CLI_REFERENCE.md).
 
-```bash
-npx octocode-cli
-```
+### Interactive menu
 
-### CLI Commands
-For automation and power users, Octocode CLI offers a comprehensive command-line interface.
+| Item | What it does |
+|------|-------------|
+| Octocode MCP | Install and configure octocode-mcp for your IDEs |
+| Octocode Skills | Quick-install bundled Octocode skills |
+| Manage System Skills | Marketplace and installed skills list |
+| Manage Auth | Sign in/out via Octocode OAuth or gh CLI |
+| Manage System MCP | Sync configs, browse MCP marketplace, inspect settings |
 
-#### 1. Install Octocode MCP
-Install the GitHub MCP server for your preferred IDE.
+### CLI commands
 
-```bash
-# Interactive install
-octocode-cli install
+| Command | Aliases | Description |
+|---------|---------|-------------|
+| `install` | `i` | Configure octocode-mcp for an IDE |
+| `skills` | `sk` | List, install, or remove bundled skills |
+| `sync` | `sy` | Sync MCP configs across IDEs |
+| `mcp` | - | Non-interactive MCP marketplace management (`list`, `status`, `install`, `remove`) |
+| `auth` | `a`, `gh` | Auth menu (`auth login`, `logout`, `status`, `token`) |
+| `login` / `logout` | `l` | GitHub OAuth login/logout |
+| `token` | `t` | Print token; `--json` for machine output |
+| `status` | `s` | GitHub auth status |
+| `cache` | - | Inspect/clean disk cache |
 
-# Specific IDEs
-octocode-cli install --ide cursor --method npx
-octocode-cli install --ide claude-desktop --method direct
-octocode-cli install --ide windsurf
-```
-
-#### 2. Manage Authentication
-Securely authenticate with GitHub. Credentials are encrypted (AES-256-GCM) and stored in `~/.octocode/`.
-
-```bash
-# Interactive login
-octocode-cli login
-
-# Check status
-octocode-cli status
-
-# Enterprise Login
-octocode-cli login --hostname github.mycompany.com
-```
+Full options and examples: [CLI Reference](https://github.com/bgauryy/octocode-mcp/blob/main/packages/octocode-cli/docs/CLI_REFERENCE.md).
 
-#### 3. Sync Configurations
-Keep your MCP settings consistent across different editors.
-
-```bash
-# Sync all IDEs
-octocode-cli sync
+---
 
-# Preview changes
-octocode-cli sync --dry-run
-```
+## Installing Skills Across Clients
 
-#### 4. Manage Skills
-Install AI skills for Claude Code.
+Default install target is `claude-code` (`~/.claude/skills/`). You can install to multiple targets with `--targets` and choose `copy` or `symlink` mode.
 
 ```bash
-# List available skills
-octocode-cli skills list
-
-# Install all standard skills
-octocode-cli skills install
+npx octocode-cli skills list                                        # see what's installed
+npx octocode-cli skills install --skill octocode-researcher         # install one skill
+npx octocode-cli skills install --skill octocode-researcher --force # update existing
+npx octocode-cli skills install                                     # install all (default target)
+npx octocode-cli skills install --skill octocode-researcher --targets cursor # one provider
+npx octocode-cli skills install --targets claude-code,cursor,codex  # multi-target install
+npx octocode-cli skills install --skill octocode-researcher --targets claude-code,claude-desktop,cursor,codex,opencode # all providers
+npx octocode-cli skills install --targets claude-code,cursor --mode symlink
+npx octocode-cli skills remove --skill octocode-researcher --targets claude-code,cursor
 ```
 
-#### 5. Additional Commands
-Other useful commands for power users.
+Supported skills `--targets`: `claude-code`, `claude-desktop`, `cursor`, `codex`, `opencode`.
 
-```bash
-# Logout from GitHub
-octocode-cli logout
+| Skill | When to use |
+|-------|-------------|
+| `octocode-researcher` | Code exploration — find, trace, definitions |
+| `octocode-research` | Deep research via HTTP research server |
+| `octocode-plan` | Plan → implement → verify |
+| `octocode-rfc-generator` | RFCs and design docs |
+| `octocode-pull-request-reviewer` | PR and staged-change review |
+| `octocode-local-code-quality` | Architecture, security, dead code audits |
+| `octocode-documentation-writer` | Generate project documentation |
+| `octocode-prompt-optimizer` | Harden prompts and SKILL files |
+| `octocode-roast` | Brutally honest code critique |
 
-# Get GitHub token (for scripting)
-octocode-cli token
+Set `"skillsDestDir"` in `~/.octocode/config.json` to customize the `claude-code` destination (for example, project-scoped `.claude/skills`).
 
-# Auth management menu
-octocode-cli auth
-```
+Full reference: [Skills Guide](https://github.com/bgauryy/octocode-mcp/blob/main/packages/octocode-cli/docs/SKILLS_GUIDE.md).
 
 ---
 
-## 🖥️ Supported Clients
+## Supported Clients
 
-Octocode CLI supports a wide range of AI-first editors and tools.
-
-| Client | Description | Config Location (macOS) |
-|--------|-------------|-------------------------|
-| **Cursor** | AI-first code editor | `~/.cursor/mcp.json` |
-| **Claude Desktop** | Anthropic's desktop app | `~/Library/Application Support/Claude/` |
-| **Windsurf** | Codeium AI IDE | `~/.codeium/windsurf/mcp_config.json` |
-| **Zed** | High-performance editor | `~/.config/zed/settings.json` |
-| **Claude Code** | CLI Assistant | `~/.claude.json` |
-| **Trae** | Adaptive AI IDE | `~/Library/Application Support/Trae/mcp.json` |
-| **Antigravity** | Gemini-powered AI IDE | `~/.gemini/antigravity/mcp_config.json` |
-| **Opencode** | AI coding agent CLI | `~/.config/opencode/config.json` |
-| **VS Code Extensions** | Cline, Roo-Cline, Continue | *(Varies by extension)* |
+| Client | Config Location (macOS) |
+|--------|-------------------------|
+| Cursor | `~/.cursor/mcp.json` |
+| Claude Desktop | `~/Library/Application Support/Claude/` |
+| Windsurf | `~/.codeium/windsurf/mcp_config.json` |
+| Zed | `~/.config/zed/settings.json` |
+| Claude Code | `~/.claude.json` |
+| Trae | `~/Library/Application Support/Trae/mcp.json` |
+| Antigravity | `~/.gemini/antigravity/mcp_config.json` |
+| Opencode | `~/.config/opencode/config.json` |
+| VS Code (Cline, Roo-Cline, Continue) | Varies by extension |
 
 ---
 
-## 🔧 Troubleshooting
-
-If you encounter issues, try the following commands:
+## Troubleshooting
 
 ```bash
-# Diagnose environment issues
-npx node-doctor
-
-# Reset local credentials
-rm -rf ~/.octocode && octocode-cli login
-
-# Verify auth status
-octocode-cli status
+npx node-doctor                          # diagnose environment
+rm -rf ~/.octocode && octocode-cli login # reset credentials
+octocode-cli status                      # verify auth
 ```
 
-**Common Issues:**
-- **Token Expired**: Run `octocode-cli login` to refresh credentials.
-- **Browser Not Opening**: Copy the authorization URL manually from the terminal.
+- **Token expired** — run `octocode-cli login`.
+- **Browser not opening** — copy the authorization URL from the terminal.
 
 ---
 
-## 📄 License
+## Privacy & Telemetry
 
-This project is licensed under the **PolyForm Small Business License 1.0.0**.
+De-identified telemetry (command usage, error rates) is collected to improve the tool. Source code, env vars, and PII are never collected. Opt out: `export LOG=false`
+
+[Privacy Policy](https://github.com/bgauryy/octocode-mcp/blob/main/PRIVACY.md) | [Terms of Usage](https://github.com/bgauryy/octocode-mcp/blob/main/TERMS.md)
+
+---
 
-Copyright © 2024 Octocode AI.
+MIT. Copyright 2026 Octocode AI.