Getting Started

Installation

Build OPIDE from source. The first build takes 2-3 minutes to compile the Rust backend. Subsequent launches are fast.

◆Tip

OPIDE is pre-release. Binary installers are not yet available. Building from source is the only option for now. Reach out at pawz@openpawz.ai if you want early access.

Prerequisites#

You need three things installed before you can build OPIDE:

Rust 1.75+#

Install via rustup, the official Rust toolchain installer. Do not use a system package manager — the version will be too old.

bash

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source $HOME/.cargo/env
rustc --version  # should be 1.75.0 or higher

Node.js 18+#

OPIDE uses Node for the Monaco editor frontend. Install via nvm or directly from nodejs.org.

bash

node --version  # should be v18.0.0 or higher
npm --version

Tauri CLI#

The Tauri CLI orchestrates the build and dev server.

bash

cargo install tauri-cli

Build and run#

1

Clone the repository

bash

git clone https://github.com/openpawz/opide.git
cd opide

2

Install frontend dependencies

bash

npm install

3

Start the development build

bash

npm run tauri:dev

The first run compiles the Rust backend — expect 2-3 minutes. After that, hot-reload keeps the frontend fast and the Rust layer only recompiles on changes.

4

Configure your first provider

On first launch the provider setup panel opens automatically. Pick a provider, add your API key, and you are ready. See Configure a Provider for details on each supported provider.

Verify the build#

Before running the full app, you can verify the Rust backend compiles cleanly:

bash

cargo check

This catches type errors and borrow checker issues without the full link step. If cargo check passes, npm run tauri:dev will build.

Platform notes#

macOS#

◆Tested on macOS 13+ (Ventura and later). Apple Silicon and Intel both work.
◆Keychain integration uses macOS Keychain for API key storage automatically.
◆No additional dependencies needed beyond the three prerequisites.

Linux#

◆Requires webkit2gtk for the Tauri webview.
◆Keychain integration uses libsecret / secret-service.
◆On Ubuntu/Debian: sudo apt install libwebkit2gtk-4.1-dev libayatana-appindicator3-dev

Windows#

◆Requires Microsoft Edge WebView2 runtime (usually pre-installed on Windows 11).
◆Keychain integration uses Windows Credential Manager.
◆Build with npm run tauri:dev as normal.

⚠Warning

The extension runtime is not included in the open source repository — it is part of the paid product surface. Public API stubs allow the codebase to compile and run without it. The full extension runtime ships with the published OPIDE program.

← PreviousIntroduction

Next →Configure a Provider