AI coding agent, built for the terminal. https://opencode.ai
Find a file
2025-07-20 12:36:53 -04:00
.github/workflows wip: github actions 2025-07-20 12:36:53 -04:00
infra Api: add endpoint for getting github app token 2025-07-11 05:01:27 +08:00
packages wip: github actions 2025-07-20 12:36:53 -04:00
scripts wip: github actions 2025-07-20 12:36:53 -04:00
sdks wip: github actions 2025-07-20 12:36:53 -04:00
.editorconfig chore: add .editorconfig (#536) 2025-06-29 21:12:58 -04:00
.gitignore chore: better local dev with stainless script 2025-07-03 11:49:15 -05:00
AGENTS.md docs: fix agents.md 2025-07-14 20:23:05 -04:00
bun.lock shitty hack for terrible charm bubbletea performance 2025-07-19 15:00:11 -04:00
bunfig.toml Optimize package management with catalog and exact versions 2025-05-30 21:56:37 -04:00
install ci: rollback install script 2025-07-18 18:57:58 -04:00
LICENSE docs: cleanup casing 2025-06-20 15:35:25 -05:00
opencode.json pass through model.options properly without having to nest it under provider name. you may have to update your configs see https://opencode.ai/docs/models/#openrouter for an example 2025-07-19 12:41:58 -04:00
package.json fix: type 'reasoning' was provided without its required following item (#1072) 2025-07-16 15:59:40 -05:00
README.md Added install dir priority & user feedback (#1129) 2025-07-18 14:15:10 -04:00
sst-env.d.ts Api: add endpoint for getting github app token 2025-07-11 05:01:27 +08:00
sst.config.ts sync 2025-05-30 20:48:36 -04:00
stainless-workspace.json chore: better local dev with stainless script 2025-07-03 11:49:15 -05:00
stainless.yml wip: file part source in server/api (optional) 2025-07-20 05:39:18 -05:00
STATS.md ignore: update download stats 2025-07-20 2025-07-20 12:04:10 +00:00
tsconfig.json ci: daily stats script 2025-06-28 21:57:46 -04:00

opencode logo

AI coding agent, built for the terminal.

Discord npm Build status

opencode Terminal UI


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
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:

  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
# 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 run packages/opencode/src/index.ts

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.


Join our community Discord | YouTube | X.com