Skip to main content

Quick Start

Get up and running in under 5 minutes with the desktop app or CLI launcher.

Installation

All installation methods — npm, curl, GitHub Releases, AUR.

Desktop App

Learn the kanban board, task execution, batch operations, and model selection.

API Reference

Complete REST API documentation for tasks, teams, projects, and execution.

What Ships

OpenLinear is distributed as a monorepo with several components:

Desktop App

Tauri desktop app with a Next.js webview — the primary way to use OpenLinear. Includes the sidecar API for local execution.

CLI Launcher

The openlinear npm package — launches the desktop app and handles GitHub authentication from the terminal.

npm Library

TypeScript utilities for execution metadata validation, payload sanitization, and feature flag management.

Landing Site

Next.js marketing and documentation surface, deployed on Vercel.

How It Works

1

Create a Task

Describe what you want built in plain language on the kanban board. Add labels, set priority, assign to a project.
2

Connect a Repository

Link a GitHub repository or point to a local folder. OpenLinear clones it and creates a working branch.
3

Execute

Click execute. An AI agent (powered by OpenCode) reads your task, writes the code, and commits changes — all locally on your machine.
4

Review the PR

OpenLinear pushes the branch and gives you a compare URL. Review the diff, open a PR, and merge when ready.

Agent Support

AgentStatus
OpenCodeIntegrated
Claude CodePlanned
CodexPlanned
AiderPlanned

Tech Stack

LayerTechnology
Desktop shellTauri 2.x (Rust)
Desktop UINext.js 16, React 19
UI componentsRadix UI + shadcn/ui
StylingTailwind CSS
Local APIExpress 5 (sidecar)
DatabasePostgreSQL via Prisma
AuthJWT + GitHub OAuth
AI executionOpenCode SDK
ValidationZod
Real-timeServer-Sent Events
BuildTurbo + pnpm workspaces