Skip to content

Commit 624b2fc

Browse files
committed
update readme
1 parent 6612eb1 commit 624b2fc

File tree

1 file changed

+41
-47
lines changed

1 file changed

+41
-47
lines changed

README.md

Lines changed: 41 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,46 @@
1-
<p align="center">
2-
<a href="https://opencode.ai">
3-
<picture>
4-
<source srcset="packages/web/src/assets/logo-ornate-dark.svg" media="(prefers-color-scheme: dark)">
5-
<source srcset="packages/web/src/assets/logo-ornate-light.svg" media="(prefers-color-scheme: light)">
6-
<img src="packages/web/src/assets/logo-ornate-light.svg" alt="opencode logo">
7-
</picture>
1+
<div align="center">
2+
<a href="https://matterai.so">
3+
<img
4+
src="https://matterai.so/favicon.png"
5+
alt="Matter AI Logo"
6+
height="64"
7+
/>
88
</a>
9-
</p>
10-
<p align="center">AI coding agent, built for the terminal.</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/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>
15-
</p>
16-
17-
[![opencode Terminal UI](packages/web/src/assets/lander/screenshot.png)](https://opencode.ai)
9+
<br />
10+
<p>
11+
<h3>
12+
<b>
13+
Axon Code
14+
</b>
15+
</h3>
16+
</p>
17+
<p>
18+
<b>
19+
AI Coding agent for your Terminal
20+
</b>
21+
</p>
22+
<p>
23+
24+
![Matter Og Image](https://res.cloudinary.com/dxvbskvxm/image/upload/v1759129700/Screenshot_2025-09-29_at_12.35.31_tkxne4.png)
25+
26+
</p>
27+
</div>
28+
29+
> [!NOTE]
30+
> This cli agent is a fork of OpenCode cli agent, originally here: [https://github.com/sst/opencode](https://github.com/sst/opencode). Please give them a star for building a 100% OSS version.
1831
1932
---
2033

2134
### Installation
2235

2336
```bash
2437
# YOLO
25-
curl -fsSL https://opencode.ai/install | bash
38+
curl -fsSL https://api.matterai.so/install | bash
2639

2740
# Package managers
28-
npm i -g opencode-ai@latest # or bun/pnpm/yarn
29-
brew install sst/tap/opencode # macOS and Linux
30-
paru -S opencode-bin # Arch Linux
41+
npm i -g axoncode-ai@latest # or bun/pnpm/yarn
42+
brew install sst/tap/axoncode # macOS and Linux
43+
paru -S axoncode-bin # Arch Linux
3144
```
3245

3346
> [!TIP]
@@ -37,24 +50,24 @@ paru -S opencode-bin # Arch Linux
3750

3851
The install script respects the following priority order for the installation path:
3952

40-
1. `$opencode_INSTALL_DIR` - Custom installation directory
53+
1. `$axoncode_INSTALL_DIR` - Custom installation directory
4154
2. `$XDG_BIN_DIR` - XDG Base Directory Specification compliant path
4255
3. `$HOME/bin` - Standard user binary directory (if exists or can be created)
43-
4. `$HOME/.opencode/bin` - Default fallback
56+
4. `$HOME/.axoncode/bin` - Default fallback
4457

4558
```bash
4659
# Examples
47-
opencode_INSTALL_DIR=/usr/local/bin curl -fsSL https://opencode.ai/install | bash
48-
XDG_BIN_DIR=$HOME/.local/bin curl -fsSL https://opencode.ai/install | bash
60+
axoncode_INSTALL_DIR=/usr/local/bin curl -fsSL https://api.matterai.so/install | bash
61+
XDG_BIN_DIR=$HOME/.local/bin curl -fsSL https://api.matterai.so/install | bash
4962
```
5063

5164
### Documentation
5265

53-
For more info on how to configure opencode [**head over to our docs**](https://opencode.ai/docs).
66+
For more info on how to configure axoncode [**head over to our docs**](https://docs.matterai.so).
5467

5568
### Contributing
5669

57-
opencode is an opinionated tool so any fundamental feature needs to go through a
70+
axoncode is an opinionated tool so any fundamental feature needs to go through a
5871
design process with the core team.
5972

6073
> [!IMPORTANT]
@@ -74,7 +87,7 @@ Take a look at the git history to see what kind of PRs we end up merging.
7487
> [!NOTE]
7588
> If you do not follow the above guidelines we might close your PR.
7689
77-
To run opencode locally you need.
90+
To run axoncode locally you need.
7891

7992
- Bun
8093
- Golang 1.24.x
@@ -88,23 +101,4 @@ $ bun dev
88101

89102
#### Development Notes
90103

91-
**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.
92-
93-
### FAQ
94-
95-
#### How is this different than Claude Code?
96-
97-
It's very similar to Claude Code in terms of capability. Here are the key differences:
98-
99-
- 100% open source
100-
- 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.
101-
- 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.
102-
- 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.
103-
104-
#### What's the other repo?
105-
106-
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).
107-
108-
---
109-
110-
**Join our community** [Discord](https://discord.gg/opencode) | [X.com](https://x.com/opencode)
104+
**API Client**: After making changes to the TypeScript API endpoints in `packages/axoncode/src/server/server.ts`, you will need the axoncode team to generate a new stainless sdk for the clients.

0 commit comments

Comments
 (0)