Skip to content

Commit 872c526

Browse files
junjun
authored andcommitted
docs(readme): add source install instructions for macOS/Linux and Windows
Quick start now includes a collapsible section with curl-based Bun canary install + git clone instructions for both platforms. Source install gives access to memory ownership patches and runtime improvements before they reach the npm package.
1 parent 6c14e34 commit 872c526

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,33 @@ npm install -g @bitkyc08/opencodex # Node 18+; the Bun runtime is bundled auto
5757
ocx start # or `ocx service` to run it in the background
5858
```
5959

60+
<details>
61+
<summary>Install from source (latest dev, Bun canary)</summary>
62+
63+
**macOS / Linux:**
64+
65+
```bash
66+
curl -fsSL https://bun.sh/install | bash && ~/.bun/bin/bun upgrade --canary
67+
git clone https://github.com/lidge-jun/opencodex.git
68+
cd opencodex && ~/.bun/bin/bun install
69+
~/.bun/bin/bun run src/cli/index.ts start
70+
```
71+
72+
**Windows (PowerShell):**
73+
74+
```powershell
75+
irm bun.sh/install.ps1 | iex; bun upgrade --canary
76+
git clone https://github.com/lidge-jun/opencodex.git
77+
cd opencodex; bun install
78+
bun run src/cli/index.ts start
79+
```
80+
81+
Source install runs the latest `dev` branch with Bun canary. Memory ownership
82+
patches, runtime GC improvements, and unreleased fixes are available here before
83+
they reach the npm package.
84+
85+
</details>
86+
6087
Open **http://localhost:10100** and configure everything in the web dashboard — add providers
6188
(40+ built-ins, or any OpenAI-compatible endpoint), pick models, manage accounts. `ocx gui`
6289
re-opens the dashboard at any time.

0 commit comments

Comments
 (0)