Skip to content

docs: improve readme for opencode package #7469

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Zhanbingli wants to merge 1 commit into
base: dev
Choose a base branch
from
+16 −12
Open

docs: improve readme for opencode package #7469

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 16 additions & 12 deletions packages/opencode/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
# js
# OpenCode CLI Core

To install dependencies:
This is the core package of OpenCode, a high-performance AI coding agent built with Bun.

```bash
bun install
```
## Setup

To run:

```bash
bun run index.ts
```

This project was created using `bun init` in bun v1.2.12. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
1. **Install Bun**: This project requires [Bun](https://bun.sh/).
```bash
curl -fsSL [https://bun.sh/install](https://bun.sh/install) | bash
2. **Install Dependencies**:
```bash
bun install
3. **Run CLI**：
```bash
bun src/index.ts --help
## Development
To start the development server:
```bash
bun run dev