Skip to content

docs: reorganize CONTRIBUTING.md local build section #265

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

Merged
anandgupta42 merged 1 commit into from
Mar 18, 2026
Merged

docs: reorganize CONTRIBUTING.md local build section #265

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
30 changes: 14 additions & 16 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,17 @@ To run Altimate Code in the root of the opencode repo itself:
bun dev .
```

### Project structure

- `packages/opencode`: Altimate Code core business logic & server.
- `packages/opencode/src/cli/cmd/tui/`: The TUI code, written in SolidJS with [opentui](https://github.com/sst/opentui)
- `packages/app`: The shared web UI components, written in SolidJS
- `packages/desktop`: The native desktop app, built with Tauri (wraps `packages/app`)
- `packages/plugin`: Source for `@altimateai/altimate-code-plugin`

### Building and running a local binary

The easiest way to build and run a compiled binary locally:
All build commands run from `packages/opencode/`.

```bash
cd packages/opencode
Expand All @@ -68,31 +76,21 @@ cd packages/opencode

# Pass flags to altimate-code
./script/local.sh -- --help
```

Or use the package.json scripts:

```bash
bun run build:local # just build for current platform
# Or use package.json scripts
bun run build:local # just build (current platform only)
bun run local # build + run
```

The script handles platform detection, `NODE_PATH` setup for native modules
like `@altimateai/altimate-core`, and binary resolution automatically.
The script handles platform detection (including Rosetta 2), `NODE_PATH` setup
for native modules like `@altimateai/altimate-core`, and binary resolution.

To compile all platform targets (CI/release):
To compile all 12 platform targets (CI/release):

```bash
bun run build
```

- Core pieces:
- `packages/opencode`: Altimate Code core business logic & server.
- `packages/opencode/src/cli/cmd/tui/`: The TUI code, written in SolidJS with [opentui](https://github.com/sst/opentui)
- `packages/app`: The shared web UI components, written in SolidJS
- `packages/desktop`: The native desktop app, built with Tauri (wraps `packages/app`)
- `packages/plugin`: Source for `@altimateai/altimate-code-plugin`

### Understanding bun dev vs opencode

During development, `bun dev` is the local equivalent of the built `opencode` command. Both run the same CLI interface:
Expand Down
Loading