mirror of
https://github.com/sst/opencode.git
synced 2025-08-22 22:14:14 +00:00
AI coding agent, built for the terminal.
https://opencode.ai
2034fabc7d
commit 7b2ad6a1abf88e0731f15bbf6e281b29a610dd76 Merge: 74c85391 |
||
|---|---|---|
| .github/workflows | ||
| .opencode/agent | ||
| cloud | ||
| github | ||
| infra | ||
| packages | ||
| script | ||
| sdks/vscode | ||
| .editorconfig | ||
| .gitignore | ||
| AGENTS.md | ||
| bun.lock | ||
| bunfig.toml | ||
| install | ||
| LICENSE | ||
| opencode.json | ||
| package.json | ||
| README.md | ||
| sst-env.d.ts | ||
| sst.config.ts | ||
| STATS.md | ||
| tsconfig.json | ||
AI coding agent, built for the terminal.
Installation
# YOLO
curl -fsSL https://opencode.ai/install | bash
# Package managers
npm i -g opencode-ai@latest # or bun/pnpm/yarn
brew install sst/tap/opencode # macOS and Linux
paru -S opencode-bin # Arch Linux
Tip
Remove versions older than 0.1.x before installing.
Installation Directory
The install script respects the following priority order for the installation path:
$OPENCODE_INSTALL_DIR- Custom installation directory$XDG_BIN_DIR- XDG Base Directory Specification compliant path$HOME/bin- Standard user binary directory (if exists or can be created)$HOME/.opencode/bin- Default fallback
# 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
Documentation
For more info on how to configure opencode head over to our docs.
Contributing
opencode is an opinionated tool so any fundamental feature needs to go through a design process with the core team.
Important
We do not accept PRs for core features.
However we still merge a ton of PRs - you can contribute:
- Bug fixes
- Improvements to LLM performance
- Support for new providers
- Fixes for env specific quirks
- Missing standard behavior
- Documentation
Take a look at the git history to see what kind of PRs we end up merging.
Note
If you do not follow the above guidelines we might close your PR.
To run opencode locally you need.
- Bun
- Golang 1.24.x
And run.
$ bun install
$ bun dev
Development Notes
API Client: After making changes to the TypeScript API endpoints in packages/opencode/src/server/server.ts, you will need the opencode team to generate a new stainless sdk for the clients.
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.
- A focus on TUI. opencode is built by neovim users and the creators of 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.