mirror of
https://github.com/aljazceru/opencode.git
synced 2025-12-25 03:34:22 +01:00
5e13527416
Co-authored-by: opencode <opencode@sst.dev> Co-authored-by: opencode-agent[bot] <opencode-agent[bot]@users.noreply.github.com>
102 lines
4.4 KiB
Markdown
102 lines
4.4 KiB
Markdown
<p align="center">
|
|
<a href="https://opencode.ai">
|
|
<picture>
|
|
<source srcset="packages/console/app/src/asset/logo-ornate-dark.svg" media="(prefers-color-scheme: dark)">
|
|
<source srcset="packages/console/app/src/asset/logo-ornate-light.svg" media="(prefers-color-scheme: light)">
|
|
<img src="packages/console/app/src/asset/logo-ornate-light.svg" alt="OpenCode logo">
|
|
</picture>
|
|
</a>
|
|
</p>
|
|
<p align="center">The AI coding agent built for the terminal.</p>
|
|
<p align="center">
|
|
<a href="https://opencode.ai/discord"><img alt="Discord" src="https://img.shields.io/discord/1391832426048651334?style=flat-square&label=discord" /></a>
|
|
<a href="https://www.npmjs.com/package/opencode-ai"><img alt="npm" src="https://img.shields.io/npm/v/opencode-ai?style=flat-square" /></a>
|
|
<a href="https://github.com/sst/opencode/actions/workflows/publish.yml"><img alt="Build status" src="https://img.shields.io/github/actions/workflow/status/sst/opencode/publish.yml?style=flat-square&branch=dev" /></a>
|
|
</p>
|
|
|
|
[](https://opencode.ai)
|
|
|
|
---
|
|
|
|
### Installation
|
|
|
|
```bash
|
|
# YOLO
|
|
curl -fsSL https://opencode.ai/install | bash
|
|
|
|
# Package managers
|
|
npm i -g opencode-ai@latest # or bun/pnpm/yarn
|
|
scoop bucket add extras; scoop install extras/opencode # Windows
|
|
choco install opencode # Windows
|
|
brew install opencode # macOS and Linux
|
|
paru -S opencode-bin # Arch Linux
|
|
mise use --pin -g ubi:sst/opencode # Any OS
|
|
nix run nixpkgs#opencode # or github:sst/opencode for latest dev branch
|
|
```
|
|
|
|
> [!TIP]
|
|
> Remove versions older than 0.1.x before installing.
|
|
|
|
#### Installation Directory
|
|
|
|
The install script respects the following priority order for the installation path:
|
|
|
|
1. `$OPENCODE_INSTALL_DIR` - Custom installation directory
|
|
2. `$XDG_BIN_DIR` - XDG Base Directory Specification compliant path
|
|
3. `$HOME/bin` - Standard user binary directory (if exists or can be created)
|
|
4. `$HOME/.opencode/bin` - Default fallback
|
|
|
|
```bash
|
|
# Examples
|
|
OPENCODE_INSTALL_DIR=/usr/local/bin curl -fsSL https://opencode.ai/install | bash
|
|
XDG_BIN_DIR=$HOME/.local/bin curl -fsSL https://opencode.ai/install | bash
|
|
```
|
|
|
|
### Agents
|
|
|
|
OpenCode includes two built-in agents you can switch between,
|
|
you can switch between these using the `Tab` key.
|
|
|
|
- **build** - Default, full access agent for development work
|
|
- **plan** - Read-only agent for analysis and code exploration
|
|
- Denies file edits by default
|
|
- Asks permission before running bash commands
|
|
- Ideal for exploring unfamiliar codebases or planning changes
|
|
|
|
Also, included is a **general** subagent for complex searches and multi-step tasks.
|
|
This is used internally and can be invoked using `@general` in messages.
|
|
|
|
Learn more about [agents](https://opencode.ai/docs/agents).
|
|
|
|
### Documentation
|
|
|
|
For more info on how to configure OpenCode [**head over to our docs**](https://opencode.ai/docs).
|
|
|
|
### Contributing
|
|
|
|
If you're interested in contributing to OpenCode, please read our [contributing docs](./CONTRIBUTING.md) before submitting a pull request.
|
|
|
|
### Building on OpenCode
|
|
|
|
If you are working on a project that's related to OpenCode and is using "opencode" as a part of its name; for example, "opencode-dashboard" or "opencode-mobile", please add a note to your README to clarify that it is not built by the OpenCode team and is not affiliated with us in anyway.
|
|
|
|
### FAQ
|
|
|
|
#### How is this different than Claude Code?
|
|
|
|
It's very similar to Claude Code in terms of capability. Here are the key differences:
|
|
|
|
- 100% open source
|
|
- Not coupled to any provider. Although Anthropic is recommended, OpenCode can be used with OpenAI, Google or even local models. As models evolve the gaps between them will close and pricing will drop so being provider-agnostic is important.
|
|
- Out of the box LSP support
|
|
- A focus on TUI. OpenCode is built by neovim users and the creators of [terminal.shop](https://terminal.shop); we are going to push the limits of what's possible in the terminal.
|
|
- A client/server architecture. This for example can allow OpenCode to run on your computer, while you can drive it remotely from a mobile app. Meaning that the TUI frontend is just one of the possible clients.
|
|
|
|
#### What's the other repo?
|
|
|
|
The other confusingly named repo has no relation to this one. You can [read the story behind it here](https://x.com/thdxr/status/1933561254481666466).
|
|
|
|
---
|
|
|
|
**Join our community** [Discord](https://discord.gg/opencode) | [X.com](https://x.com/opencode)
|