monkeyscode-cli 0.1.0

package/README.md

@@ -0,0 +1,226 @@
+# MonkeysCode CLI
+
+> AI-powered coding agent for the terminal. Works on macOS, Linux, and Windows.
+
+[![npm version](https://img.shields.io/npm/v/@monkeyscode/cli)](https://www.npmjs.com/package/@monkeyscode/cli)
+[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/MonkeysCloud/monkeyscode/cli-release.yml)](https://github.com/MonkeysCloud/monkeyscode/actions)
+[![License](https://img.shields.io/badge/license-MIT-blue)](LICENSE)
+
+<!-- TODO: Replace with actual asciinema recording -->
+<!-- ![MonkeysCode CLI Demo](docs/assets/demo.gif) -->
+
+## Quick Install
+
+```bash
+# macOS / Linux
+curl -fsSL https://monkeyscode.com/install.sh | sh
+
+# Windows (PowerShell)
+irm https://monkeyscode.com/install.ps1 | iex
+
+# npm
+npm install -g @monkeyscode/cli
+
+# Homebrew
+brew install monkeyscode
+```
+
+## Usage
+
+```bash
+# Interactive REPL
+mc "refactor the auth module"
+
+# Headless (CI/CD)
+mc -p "fix all lint errors" --headless --auto-approve
+
+# Background job with auto-PR
+mc -p "write tests" --background --auto-branch --auto-pr
+
+# Pipe mode
+echo "explain this error" | mc
+
+# Model selection
+mc --model claude-opus "deep architecture review"
+```
+
+<!-- TODO: Record with asciinema and convert to GIF -->
+<!-- ![Interactive session](docs/assets/interactive.gif) -->
+
+## Features
+
+### 🤖 Multi-Model Support
+Switch between Claude, GPT-4o, Gemini, and MonkeysCode's own Capuchin model.
+
+```bash
+mc --model auto "fix the bug"       # Smart model selection
+mc --model claude-opus "review PR"  # Specific model
+```
+
+### 📁 Full Tool Suite
+The agent can edit files, run terminal commands, search code, and manage git — all locally.
+
+<!-- TODO: Record with asciinema -->
+<!-- ![Tool execution](docs/assets/tools.gif) -->
+
+### 🔒 Sandboxed Execution
+Run agent commands in isolated sandboxes (bubblewrap, sandbox-exec, Docker).
+
+```bash
+mc --sandbox "run the migration script"
+mc --sandbox-network=none "process sensitive data"
+```
+
+### 🌐 Background Jobs
+Submit long-running tasks to the cloud and get notified when done.
+
+```bash
+mc -p "write comprehensive tests" --background --auto-pr
+mc jobs list
+mc jobs logs abc123 --follow
+```
+
+### 🧠 Memory & Conventions
+The agent learns your project's conventions and remembers them.
+
+```bash
+mc memory add "Always use camelCase for variables"
+mc memory show
+mc dream           # Consolidate session history into memory
+```
+
+### ⚡ CI/CD Integration
+Run headlessly in GitHub Actions, GitLab CI, or any CI system.
+
+```yaml
+# .github/workflows/review.yml
+- uses: MonkeysCloud/monkeyscode@main
+  with:
+    prompt: 'Review this PR'
+    mode: plan
+    output: github
+    api-key: ${{ secrets.MONKEYSCODE_API_KEY }}
+```
+
+### 🔌 MCP Servers
+Extend the agent with custom tools via the Model Context Protocol.
+
+```bash
+mc mcp add jira npx @monkeyscode/mcp-jira
+mc mcp add slack npx @monkeyscode/mcp-slack
+mc mcp list
+```
+
+### 👥 Multi-Agent Teams
+Spawn parallel agents to divide and conquer large tasks.
+
+```bash
+mc team spawn --task "Implement auth, payments, and email modules"
+mc team status
+mc team merge team-abc123
+```
+
+## Output Formats
+
+| Format | Use Case |
+|--------|----------|
+| `text` | Interactive terminal (default) |
+| `json` | Structured result for scripts |
+| `jsonl` | Streaming events for real-time parsing |
+| `diff` | Unified diff (`git apply` compatible) |
+| `markdown` | Clean markdown (for PR descriptions) |
+| `github` | GitHub Actions output format |
+| `azure` | Azure DevOps format |
+| `sarif` | SARIF 2.1.0 for code scanning |
+
+## Configuration
+
+```bash
+mc config set defaultModel claude-sonnet    # Set default model
+mc config set theme dark                     # Set theme
+mc config list                               # Show all settings
+mc config path                               # Show config file locations
+```
+
+Project-level config: `.monkeyscode/config.json`
+
+## Shell Completions
+
+```bash
+mc completions bash >> ~/.bashrc
+mc completions zsh >> ~/.zshrc
+mc completions fish > ~/.config/fish/completions/mc.fish
+mc completions powershell >> $PROFILE
+```
+
+## Slash Commands (REPL)
+
+| Command | Description |
+|---------|-------------|
+| `/help` | Show all commands |
+| `/model <name>` | Switch model |
+| `/mode <mode>` | Switch mode (agent/plan/ask) |
+| `/compact` | Toggle compact output |
+| `/diff` | Show session changes |
+| `/undo` | Revert last edit |
+| `/commit [msg]` | Commit changes |
+| `/files` | List touched files |
+| `/cost` | Show token usage |
+| `/vim` | Toggle Vim keybindings |
+| `/cloud` | Hand off to cloud |
+| `/context <file>` | Add file to context |
+
+## SDK
+
+Build custom integrations with the TypeScript SDK:
+
+```bash
+npm install @monkeyscode/sdk
+```
+
+```typescript
+import { MonkeysCode } from '@monkeyscode/sdk';
+
+const agent = new MonkeysCode({ apiKey: process.env.MONKEYSCODE_API_KEY });
+const result = await agent.run('Fix all TypeScript errors');
+console.log(result.summary);
+```
+
+See [`@monkeyscode/sdk`](../packages/sdk-typescript/) for full documentation.
+
+## Accessibility
+
+Screen reader-friendly mode (no ANSI codes, no animations):
+
+```bash
+mc --accessible "fix the bug"
+# or
+export MONKEYSCODE_ACCESSIBLE=1
+```
+
+## Telemetry
+
+Telemetry is enabled by default and collects anonymous usage data to improve the product.
+
+```bash
+mc telemetry status    # Check status
+mc telemetry disable   # Opt out
+mc telemetry show      # See what's collected
+```
+
+Respects the `DO_NOT_TRACK=1` environment variable.
+
+## Documentation
+
+- [CLI Overview](../../docs/coding-agent/cli/00-cli-overview.md)
+- [Core Runtime](../../docs/coding-agent/cli/01-core-runtime.md)
+- [Interactive Experience](../../docs/coding-agent/cli/02-interactive-experience.md)
+- [Auth & Configuration](../../docs/coding-agent/cli/03-auth-configuration.md)
+- [Headless / CI/CD](../../docs/coding-agent/cli/04-headless-cicd.md)
+- [Background & Cloud](../../docs/coding-agent/cli/05-background-cloud.md)
+- [Distribution](../../docs/coding-agent/cli/06-distribution.md)
+- [SDK & Extensibility](../../docs/coding-agent/cli/07-sdk-extensibility.md)
+
+## License
+
+MIT © [MonkeysCloud Corp](https://monkeyscode.com)