mirror of
https://github.com/sst/opencode.git
synced 2025-07-07 16:14:59 +00:00
79 lines
3.2 KiB
Markdown
79 lines
3.2 KiB
Markdown
<p align="center">
|
|
<a href="https://opencode.ai">
|
|
<picture>
|
|
<source srcset="packages/web/src/assets/logo-ornate-dark.svg" media="(prefers-color-scheme: dark)">
|
|
<source srcset="packages/web/src/assets/logo-ornate-light.svg" media="(prefers-color-scheme: light)">
|
|
<img src="packages/web/src/assets/logo-ornate-light.svg" alt="opencode logo">
|
|
</picture>
|
|
</a>
|
|
</p>
|
|
<p align="center">AI coding agent, built for the terminal.</p>
|
|
<p align="center">
|
|
<a href="https://opencode.ai/docs"><img alt="View docs" src="https://img.shields.io/badge/view-docs-blue?style=flat-square" /></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
|
|
brew install sst/tap/opencode # macOS
|
|
paru -S opencode-bin # Arch Linux
|
|
```
|
|
|
|
> **Note:** Remove versions older than 0.1.x before installing
|
|
|
|
### Documentation
|
|
|
|
For more info on how to configure opencode [**head over to our docs**](https://opencode.ai/docs).
|
|
|
|
### Contributing
|
|
|
|
For any new features we'd appreciate it if you could open an issue first to discuss what you'd like to implement. We're pretty responsive there and it'll save you from working on something that we don't end up using. No need to do this for simpler fixes.
|
|
|
|
> **Note**: Please talk to us via github issues before spending time working on
|
|
> a new feature
|
|
|
|
To run opencode locally you need.
|
|
|
|
- Bun
|
|
- Golang 1.24.x
|
|
|
|
And run.
|
|
|
|
```bash
|
|
$ 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](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** [YouTube](https://www.youtube.com/c/sst-dev) | [X.com](https://x.com/SST_dev)
|