# OctoCode

AI-powered development tool for the terminal. Works with OpenAI, Anthropic, Google, and more.

**[Star on GitHub](https://github.com/farhanic017/octocode)** | [npm](https://www.npmjs.com/package/octocode-ai)

## Install

```bash
npm install -g octocode-ai
```

Then run `octo` in your terminal.

## Features

- **Multi-provider AI** — OpenAI, Anthropic, Google, Xiaomi, and custom providers
- **Terminal UI** — Rich interactive TUI with themes, split views, and keyboard shortcuts
- **Code editing** — Read, write, edit files with full diff support
- **Shell execution** — Run commands with safety checks
- **Git integration** — Commit, diff, branch operations
- **Memory system** — Episodic and procedural memory with FTS5 search
- **Learning loop** — Auto-crystallizes complex tasks into reusable Skills
- **Checkpointing** — File snapshots before changes with rollback support
- **Task scheduling** — Cron expressions for recurring tasks
- **Web search fallback** — Browser-based search when API search fails
- **Extension browser** — Playwright-based browser for JavaScript-rendered pages
- **Personality system** — Adaptive mood, voice, and growth tracking
- **Agent swarm** — Parallel multi-agent orchestration

## Quick Start

```bash
# Install
npm install -g octocode-ai

# Run
octo

# Set up a provider (e.g., OpenAI)
octo providers
```

## Supported Platforms

| Platform | Package |
|---|---|
| macOS Apple Silicon | `octocode-ai-darwin-arm64` |
| Linux ARM64 | `octocode-ai-linux-arm64` |
| Linux x64 | `octocode-ai-linux-x64` |
| Windows ARM64 | `octocode-ai-windows-arm64` |
| Windows x64 | `octocode-ai-windows-x64` |

## Documentation

- [GitHub](https://github.com/farhanic017/octocode)
- [npm](https://www.npmjs.com/package/octocode-ai)

## License

GPL-3.0-or-later

## Support

If you find OctoCode useful, please [star the GitHub repo](https://github.com/farhanic017/octocode) — it helps others discover the project.