Skip to main content

Prerequisites

Koharu is developed against Rust 1.97.1 with the 2024 edition, Bun 1.3.14, and LLVM 22.1.8. The repository does not pin these versions. LLVM supplies the libclang that the -sys crates’ bindings are generated with; the native libraries themselves are prebuilt packages downloaded at runtime, so no C++ build system is required.
Install the MSVC C/C++ build tools for native dependencies.

Start development

bun install also installs the Tauri CLI at the revision the workspace uses, with cargo install. bun dev runs cargo tauri dev, which starts the Next.js interface on port 3000 and the desktop app, and downloads CEF on the first build. Debug builds expose CEF remote debugging at http://127.0.0.1:4000.
The Tauri CLI sets CEF_PATH for the builds it runs. Plain cargo commands on crates that link CEF, such as koharu and koharu-desktop, need it set to the same folder, tauri-cef under the operating system’s cache folder, or they download CEF again and rebuild it. On Windows that is %LOCALAPPDATA%\tauri-cef.

Check the affected component

Run the smallest relevant debug check or focused test once. For example:
For interface work, bun run test runs the interface’s Vitest suite and bun run lint runs its linter. bun run check checks formatting across the repository’s TypeScript and JSON.
Do not run full suites, non-debug profiles, or end-to-end tests by default. Run them only when explicitly requested.

Regenerate IPC bindings

Rust command signatures and their Specta types are authoritative:
Do not hand-edit packages/ipc/src/protocol.ts.

Build an executable

When you need a release executable, bun run build runs cargo tauri build --no-bundle and writes to target/release. Installer packaging belongs to the release workflow.

Work on the documentation

Preview Mintlify and maintain the English, Japanese, and Chinese documentation.