Skip to main content

​
System Requirements

RequirementMinimum
Node.js22+
pnpm9+ (for development only)
OSmacOS 10.15+ (Apple Silicon / Intel) or Linux x64
Disk~200 MB
The global npm package installs the CLI launcher and downloads the desktop binary on first run. 
npm install -g openlinear
After installation: 
openlinear
The postinstall script downloads the pre-built desktop binary for your platform:
  • macOS: Installs OpenLinear.app to ~/Applications/
  • Linux: Places the AppImage at ~/.openlinear/openlinear.AppImage and registers a .desktop entry at ~/.local/share/applications/openlinear.desktop
The CLI launcher resolves the binary from these known paths on each run.

​
curl Installer

A single command that detects your platform and installs the latest release: 
curl -fsSL https://rixie.in/api/install | bash
  1. Detects your OS and architecture
  2. Downloads the latest release from GitHub Releases
  3. Installs the binary to ~/.openlinear/ (Linux) or ~/Applications/ (macOS)
  4. Registers the openlinear command in your PATH

​
GitHub Releases

Download pre-built binaries directly:
PlatformFormatLink
macOS (Universal).dmgLatest Release
macOS (Universal).app.tar.gzLatest Release
Linux x64AppImageLatest Release
Linux x64.debLatest Release

​
Arch Linux (AUR)

paru -S openlinear-bin
The AUR package points at GitHub Release artifacts and installs the desktop binary.

​
Build from Source

For contributors or custom builds: 
git clone https://github.com/kaizen403/openlinear.git
cd openlinear
pnpm install

# Build the sidecar (local API server)
pnpm build:sidecar

# Build the desktop app
pnpm build:desktop

# Or build everything
pnpm build:app
Building the desktop app requires Rust and the Tauri CLI. See the Tauri prerequisites.

​
Development Mode

# Run everything (desktop + sidecar + API)
pnpm dev

# Run only the landing/docs site
pnpm dev:web

# Run only the landing site
pnpm --filter @openlinear/landing dev
The landing site runs on port 3002 by default.

​
Verifying Installation

# Check the CLI is installed
openlinear --version

# Check GitHub authentication
openlinear github status

# Launch the app
openlinear
If the desktop binary is not found, the CLI prints installation instructions: 
OpenLinear desktop app not found.

Install it from npm:
  npm install -g openlinear

Or download the latest desktop release:
  https://github.com/kaizen403/openlinear/releases/latest

​
Uninstalling

npm uninstall -g openlinear
rm -rf ~/.openlinear
rm -rf ~/Applications/OpenLinear.app

​
Next Steps

Quick Start

Create your first task and execute it.

GitHub Auth

Set up GitHub authentication for repository access.