Skip to content

Commit aa89c20

Browse files
rmp22rmp22
committed
docs(ocx): refresh README presentation
1 parent 43c60b9 commit aa89c20

1 file changed

Lines changed: 64 additions & 76 deletions

File tree

‎README.md‎

Lines changed: 64 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,43 @@
11
<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>
2+
<picture>
3+
<source srcset="packages/console/app/src/asset/logo-ornate-dark.svg" media="(prefers-color-scheme: dark)">
4+
<source srcset="packages/console/app/src/asset/logo-ornate-light.svg" media="(prefers-color-scheme: light)">
5+
<img src="packages/console/app/src/asset/logo-ornate-light.svg" alt="OpenCode-X logo">
6+
</picture>
97
</p>
10-
<p align="center">The open source AI coding agent.</p>
8+
9+
<h1 align="center">OpenCode-X</h1>
1110

1211
<p align="center">
13-
<a href="README.md">English</a>
12+
A source-first coding agent for existing codebases.
1413
</p>
1514

16-
[![OpenCode Terminal UI](packages/web/src/assets/lander/screenshot.png)](https://opencode.ai)
15+
<p align="center">
16+
<strong>Inspect first. Change deliberately. Verify the result.</strong>
17+
</p>
1718

18-
---
19+
<p align="center">
20+
<img src="packages/web/src/assets/lander/screenshot.png" alt="OpenCode-X terminal interface">
21+
</p>
1922

20-
## OpenCode-X
23+
<hr>
24+
25+
## What OpenCode-X adds
26+
27+
<table>
28+
<tr>
29+
<th>Inspect</th>
30+
<th>Plan</th>
31+
<th>Review</th>
32+
</tr>
33+
<tr>
34+
<td>Read source, instructions, and nearby code before editing.</td>
35+
<td>Use structure, strategy, and design records to set a clear change boundary.</td>
36+
<td>Keep evidence, checks, failures, and unknowns visible before completion.</td>
37+
</tr>
38+
</table>
39+
40+
## OpenCode-X origin
2141

2242
OpenCode-X is an experimental fork of OpenCode focused on helping coding agents produce cleaner code when working with existing codebases.
2343

@@ -29,87 +49,55 @@ I mainly build and test OpenCode-X with fast, lower-cost models such as ChatGPT
2949

3050
The rules in OpenCode-X come from my own development experience, books, research papers, developer feedback, and testing different LLMs. The project is still experimental and changes as I find problems and better ways to handle them.
3151

32-
### Installation
52+
## Quick start
3353

34-
```bash
35-
# YOLO
36-
curl -fsSL https://opencode.ai/install | bash
37-
38-
# Package managers
39-
npm i -g opencode-ai@latest # or bun/pnpm/yarn
40-
scoop install opencode # Windows
41-
choco install opencode # Windows
42-
brew install anomalyco/tap/opencode # macOS and Linux (recommended, always up to date)
43-
brew install opencode # macOS and Linux (official brew formula, updated less)
44-
sudo pacman -S opencode # Arch Linux (Stable)
45-
paru -S opencode-bin # Arch Linux (Latest from AUR)
46-
mise use -g opencode # Any OS
47-
nix run nixpkgs#opencode # or github:anomalyco/opencode for latest dev branch
48-
```
49-
50-
> [!TIP]
51-
> Remove versions older than 0.1.x before installing.
52-
53-
### Desktop App (BETA)
54-
55-
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).
56-
57-
| Platform | Download |
58-
| --------------------- | ---------------------------------- |
59-
| macOS (Apple Silicon) | `opencode-desktop-mac-arm64.dmg` |
60-
| macOS (Intel) | `opencode-desktop-mac-x64.dmg` |
61-
| Windows | `opencode-desktop-windows-x64.exe` |
62-
| Linux | `.deb`, `.rpm`, or `.AppImage` |
54+
Build and deploy the local CLI from this checkout:
6355

6456
```bash
65-
# macOS (Homebrew)
66-
brew install --cask opencode-desktop
67-
# Windows (Scoop)
68-
scoop bucket add extras; scoop install extras/opencode-desktop
57+
./build
58+
./deploy
59+
~/.ocx/bin/ocx --help
6960
```
7061

71-
#### Installation Directory
72-
73-
The install script respects the following priority order for the installation path:
74-
75-
1. `$OPENCODE_INSTALL_DIR` - Custom installation directory
76-
2. `$XDG_BIN_DIR` - XDG Base Directory Specification compliant path
77-
3. `$HOME/bin` - Standard user binary directory (if it exists or can be created)
78-
4. `$HOME/.ocx/bin` - Default fallback
62+
Start the terminal interface in a project directory:
7963

8064
```bash
81-
# Examples
82-
OPENCODE_INSTALL_DIR=/usr/local/bin curl -fsSL https://opencode.ai/install | bash
83-
XDG_BIN_DIR=$HOME/.local/bin curl -fsSL https://opencode.ai/install | bash
65+
~/.ocx/bin/ocx
8466
```
8567

86-
### Agents
87-
88-
OpenCode includes two built-in agents you can switch between with the `Tab` key.
68+
The project is experimental. Expect the workflow rules and tools to change as
69+
they are tested against more codebases and models.
8970

90-
- **build** - Default, full-access agent for development work
91-
- **plan** - Read-only agent for analysis and code exploration
92-
- Denies file edits by default
93-
- Asks permission before running bash commands
94-
- Ideal for exploring unfamiliar codebases or planning changes
71+
## Agents
9572

96-
Also included is a **general** subagent for complex searches and multistep tasks.
97-
This is used internally and can be invoked using `@general` in messages.
73+
OpenCode-X includes two built-in agents that you can switch with `Tab`:
9874

99-
Learn more about [agents](https://opencode.ai/docs/agents).
75+
| Agent | Use it for |
76+
| --------- | ---------------------------------------- |
77+
| **build** | Full-access development work. |
78+
| **plan** | Read-only analysis and code exploration. |
10079

101-
### Documentation
80+
The **general** subagent handles complex searches and multistep tasks. Use
81+
`@general` when you need that additional exploration.
10282

103-
For more info on how to configure OpenCode, [**head over to our docs**](https://opencode.ai/docs).
83+
## Configuration
10484

105-
### Contributing
85+
| Scope | Path |
86+
| --------------------- | ---------------- |
87+
| Project configuration | `.ocx/` |
88+
| Global configuration | `~/.config/ocx/` |
89+
| CLI executable | `ocx` |
10690

107-
If you're interested in contributing to OpenCode, please read our [contributing docs](./CONTRIBUTING.md) before submitting a pull request.
91+
Project instructions live in `.ocx/AGENTS.md`. Keep that file short and store
92+
only guidance that future coding sessions are likely to miss.
10893

109-
### Building on OpenCode
94+
## Technical compatibility
11095

111-
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.
96+
Some package names, environment variables, and upstream identifiers still use
97+
`opencode` for compatibility. The user-facing fork name, CLI, and project
98+
configuration use **OpenCode-X**, `ocx`, and `.ocx`.
11299

113-
---
100+
## Contributing
114101

115-
**Join our community** [Discord](https://discord.gg/opencode) | [X.com](https://x.com/opencode)
102+
Read [CONTRIBUTING.md](./CONTRIBUTING.md) before making changes. Keep commits
103+
focused so reviewers can understand one bringup or patch at a time.

0 commit comments

Comments
 (0)