Skip to content

Commit f40dada

Browse files
docs: document chipp-ai/opencode fork status and install instructions
Notes this is a public fork of anomalyco/opencode, lists the fork-only change (subagent cost rollup, closes upstream anomalyco#45417/anomalyco#39740/anomalyco#40114/anomalyco#31032), and replaces the install section with instructions for this fork's own multi-arch releases. Upstream's package-manager installs and desktop app links are kept but marked as not maintained by this fork. Also corrects the Installation Directory section, which described $OPENCODE_INSTALL_DIR/ $XDG_BIN_DIR priority logic the install script doesn't actually implement. Co-Authored-By: Claude Sonnet 5 <[email protected]>
1 parent 4d82e83 commit f40dada

1 file changed

Lines changed: 33 additions & 15 deletions

File tree

‎README.md‎

Lines changed: 33 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@
1414
<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>
1515
</p>
1616

17+
> [!NOTE]
18+
> This is **[chipp-ai/opencode](https://github.com/chipp-ai/opencode)**, a public fork of [anomalyco/opencode](https://github.com/anomalyco/opencode) (formerly `sst/opencode`). We track upstream `dev` closely and carry a small set of fixes upstream hasn't merged yet — see [Fork changes](#fork-changes) below. Everything else in this README describes upstream OpenCode; only the Installation section differs for this fork.
19+
1720
<p align="center">
1821
<a href="README.md">English</a> |
1922
<a href="README.zh.md">简体中文</a> |
@@ -43,8 +46,32 @@
4346

4447
---
4548

49+
### Fork changes
50+
51+
This fork adds subagent cost roll-up: session cost/tokens shown in the TUI sidebar and footer, `opencode stats`, and ACP's `usage_update` now include spend from subagent (Task tool) sessions, not just the root session — fixing [anomalyco/opencode#45417](https://github.com/anomalyco/opencode/issues/45417), [#39740](https://github.com/anomalyco/opencode/issues/39740), [#40114](https://github.com/anomalyco/opencode/issues/40114), and [#31032](https://github.com/anomalyco/opencode/issues/31032) (forked sessions double-counting inherited cost). See the [`dev` branch history](https://github.com/chipp-ai/opencode/commits/dev) for the exact commits on top of upstream.
52+
4653
### Installation
4754

55+
```bash
56+
# From this fork (builds for all platforms, same install script as upstream)
57+
curl -fsSL https://raw.githubusercontent.com/chipp-ai/opencode/dev/install | bash
58+
59+
# Pin a specific fork release
60+
curl -fsSL https://raw.githubusercontent.com/chipp-ai/opencode/dev/install | bash -s -- --version 1.18.32-chipp.1
61+
```
62+
63+
Releases are published at [chipp-ai/opencode/releases](https://github.com/chipp-ai/opencode/releases). To build and install from source instead:
64+
65+
```bash
66+
git clone https://github.com/chipp-ai/opencode.git && cd opencode/packages/opencode
67+
bun install
68+
OPENCODE_VERSION=<version> bun run script/build.ts --single # current platform only
69+
./install --binary dist/opencode-<platform>-<arch>/bin/opencode
70+
```
71+
72+
<details>
73+
<summary>Upstream's package-manager installs (not maintained by this fork)</summary>
74+
4875
```bash
4976
# YOLO
5077
curl -fsSL https://opencode.ai/install | bash
@@ -61,12 +88,14 @@ mise use -g opencode # Any OS
6188
nix run nixpkgs#opencode # or github:anomalyco/opencode for latest dev branch
6289
```
6390

91+
</details>
92+
6493
> [!TIP]
6594
> Remove versions older than 0.1.x before installing.
6695
6796
### Desktop App (BETA)
6897

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).
98+
OpenCode is also available as a desktop application (upstream builds only — this fork does not currently publish desktop builds). Download directly from [anomalyco/opencode's releases page](https://github.com/anomalyco/opencode/releases) or [opencode.ai/download](https://opencode.ai/download).
7099

71100
| Platform | Download |
72101
| --------------------- | ---------------------------------- |
@@ -84,18 +113,7 @@ scoop bucket add extras; scoop install extras/opencode-desktop
84113

85114
#### Installation Directory
86115

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-
```
116+
The install script always installs to `$HOME/.opencode/bin` and adds that to your shell's PATH. Use `--no-modify-path` to skip the PATH edit, or `-b/--binary <path>` to install a binary you already built (see [Installation](#installation) above) instead of downloading one.
99117

100118
### Agents
101119

@@ -114,11 +132,11 @@ Learn more about [agents](https://opencode.ai/docs/agents).
114132

115133
### Documentation
116134

117-
For more info on how to configure OpenCode, [**head over to our docs**](https://opencode.ai/docs).
135+
For more info on how to configure OpenCode, [**head over to our docs**](https://opencode.ai/docs) (upstream's docs site; this fork doesn't maintain a separate one). The install/build differences above are the only fork-specific behavior.
118136

119137
### Contributing
120138

121-
If you're interested in contributing to OpenCode, please read our [contributing docs](./CONTRIBUTING.md) before submitting a pull request.
139+
This fork's own changes live on the [`dev` branch](https://github.com/chipp-ai/opencode/tree/dev) and are tracked against [chipp-ai/opencode issues](https://github.com/chipp-ai/opencode/issues). If you're interested in contributing to upstream OpenCode itself, please read [their contributing docs](./CONTRIBUTING.md) before submitting a pull request there.
122140

123141
### Building on OpenCode
124142

0 commit comments

Comments
 (0)