|
1 | | -<p align="center"> |
2 | | - <a href="https://opencode.ai"> |
3 | | - <picture> |
4 | | - <source srcset="packages/console/app/src/asset/logo-ornate-dark.svg" media="(prefers-color-scheme: dark)"> |
5 | | - <source srcset="packages/console/app/src/asset/logo-ornate-light.svg" media="(prefers-color-scheme: light)"> |
6 | | - <img src="packages/console/app/src/asset/logo-ornate-light.svg" alt="OpenCode logo"> |
7 | | - </picture> |
8 | | - </a> |
9 | | -</p> |
10 | | -<p align="center">The open source AI coding agent.</p> |
11 | | -<p align="center"> |
12 | | - <a href="https://opencode.ai/discord"><img alt="Discord" src="https://img.shields.io/discord/1391832426048651334?style=flat-square&label=discord" /></a> |
13 | | - <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> |
14 | | - <a href="https://github.com/anomalyco/opencode/actions/workflows/publish.yml"><img alt="Build status" src="https://img.shields.io/github/actions/workflow/status/anomalyco/opencode/publish.yml?style=flat-square&branch=dev" /></a> |
15 | | -</p> |
16 | | - |
17 | | -<p align="center"> |
18 | | - <a href="README.md">English</a> | |
19 | | - <a href="README.zh.md">简体中文</a> | |
20 | | - <a href="README.zht.md">繁體中文</a> | |
21 | | - <a href="README.ko.md">한국어</a> | |
22 | | - <a href="README.de.md">Deutsch</a> | |
23 | | - <a href="README.es.md">Español</a> | |
24 | | - <a href="README.fr.md">Français</a> | |
25 | | - <a href="README.it.md">Italiano</a> | |
26 | | - <a href="README.da.md">Dansk</a> | |
27 | | - <a href="README.ja.md">日本語</a> | |
28 | | - <a href="README.pl.md">Polski</a> | |
29 | | - <a href="README.ru.md">Русский</a> | |
30 | | - <a href="README.bs.md">Bosanski</a> | |
31 | | - <a href="README.ar.md">العربية</a> | |
32 | | - <a href="README.no.md">Norsk</a> | |
33 | | - <a href="README.br.md">Português (Brasil)</a> | |
34 | | - <a href="README.th.md">ไทย</a> | |
35 | | - <a href="README.tr.md">Türkçe</a> | |
36 | | - <a href="README.uk.md">Українська</a> | |
37 | | - <a href="README.bn.md">বাংলা</a> | |
38 | | - <a href="README.gr.md">Ελληνικά</a> | |
39 | | - <a href="README.vi.md">Tiếng Việt</a> |
40 | | -</p> |
41 | | - |
42 | | -[](https://opencode.ai) |
43 | | - |
44 | | ---- |
45 | | - |
46 | | -### Installation |
47 | | - |
48 | | -```bash |
49 | | -# YOLO |
50 | | -curl -fsSL https://opencode.ai/install | bash |
51 | | - |
52 | | -# Package managers |
53 | | -npm i -g opencode-ai@latest # or bun/pnpm/yarn |
54 | | -scoop install opencode # Windows |
55 | | -choco install opencode # Windows |
56 | | -brew install anomalyco/tap/opencode # macOS and Linux (recommended, always up to date) |
57 | | -brew install opencode # macOS and Linux (official brew formula, updated less) |
58 | | -sudo pacman -S opencode # Arch Linux (Stable) |
59 | | -paru -S opencode-bin # Arch Linux (Latest from AUR) |
60 | | -mise use -g opencode # Any OS |
61 | | -nix run nixpkgs#opencode # or github:anomalyco/opencode for latest dev branch |
62 | | -``` |
63 | | - |
64 | | -> [!TIP] |
65 | | -> Remove versions older than 0.1.x before installing. |
66 | | -
|
67 | | -### Desktop App (BETA) |
68 | | - |
69 | | -OpenCode is also available as a desktop application. Download directly from the [releases page](https://github.com/anomalyco/opencode/releases) or [opencode.ai/download](https://opencode.ai/download). |
70 | | - |
71 | | -| Platform | Download | |
72 | | -| --------------------- | ---------------------------------- | |
73 | | -| macOS (Apple Silicon) | `opencode-desktop-mac-arm64.dmg` | |
74 | | -| macOS (Intel) | `opencode-desktop-mac-x64.dmg` | |
75 | | -| Windows | `opencode-desktop-windows-x64.exe` | |
76 | | -| Linux | `.deb`, `.rpm`, or `.AppImage` | |
77 | | - |
78 | | -```bash |
79 | | -# macOS (Homebrew) |
80 | | -brew install --cask opencode-desktop |
81 | | -# Windows (Scoop) |
82 | | -scoop bucket add extras; scoop install extras/opencode-desktop |
83 | | -``` |
84 | | - |
85 | | -#### Installation Directory |
86 | | - |
87 | | -The install script respects the following priority order for the installation path: |
88 | | - |
89 | | -1. `$OPENCODE_INSTALL_DIR` - Custom installation directory |
90 | | -2. `$XDG_BIN_DIR` - XDG Base Directory Specification compliant path |
91 | | -3. `$HOME/bin` - Standard user binary directory (if it exists or can be created) |
92 | | -4. `$HOME/.opencode/bin` - Default fallback |
93 | | - |
94 | | -```bash |
95 | | -# Examples |
96 | | -OPENCODE_INSTALL_DIR=/usr/local/bin curl -fsSL https://opencode.ai/install | bash |
97 | | -XDG_BIN_DIR=$HOME/.local/bin curl -fsSL https://opencode.ai/install | bash |
98 | | -``` |
99 | | - |
100 | | -### Agents |
101 | | - |
102 | | -OpenCode includes two built-in agents you can switch between with the `Tab` key. |
103 | | - |
104 | | -- **build** - Default, full-access agent for development work |
105 | | -- **plan** - Read-only agent for analysis and code exploration |
106 | | - - Denies file edits by default |
107 | | - - Asks permission before running bash commands |
108 | | - - Ideal for exploring unfamiliar codebases or planning changes |
109 | | - |
110 | | -Also included is a **general** subagent for complex searches and multistep tasks. |
111 | | -This is used internally and can be invoked using `@general` in messages. |
112 | | - |
113 | | -Learn more about [agents](https://opencode.ai/docs/agents). |
114 | | - |
115 | | -### Documentation |
116 | | - |
117 | | -For more info on how to configure OpenCode, [**head over to our docs**](https://opencode.ai/docs). |
118 | | - |
119 | | -### Contributing |
120 | | - |
121 | | -If you're interested in contributing to OpenCode, please read our [contributing docs](./CONTRIBUTING.md) before submitting a pull request. |
122 | | - |
123 | | -### Building on OpenCode |
124 | | - |
125 | | -If you are working on a project that's related to OpenCode and is using "opencode" as 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 any way. |
126 | | - |
127 | | -### FAQ |
128 | | - |
129 | | -#### How is this different from Claude Code? |
130 | | - |
131 | | -It's very similar to Claude Code in terms of capability. Here are the key differences: |
132 | | - |
133 | | -- 100% open source |
134 | | -- Not coupled to any provider. Although we recommend the models we provide through [OpenCode Zen](https://opencode.ai/zen), OpenCode can be used with Claude, 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. |
135 | | -- Built-in opt-in LSP support |
136 | | -- 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. |
137 | | -- A client/server architecture. This, for example, can allow OpenCode to run on your computer while you drive it remotely from a mobile app, meaning that the TUI frontend is just one of the possible clients. |
138 | | - |
139 | | ---- |
140 | | - |
141 | | -**Join our community** [Discord](https://discord.gg/opencode) | [X.com](https://x.com/opencode) |
| 1 | +trying to run the last workflow in github action with another attempt |
0 commit comments