Documentation Index
Fetch the complete documentation index at: https://openlinear.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
npm install -g openlinear
Launch
The launcher searches for the desktop binary in the following order:
| Platform | Search paths |
|---|
| macOS | ~/Applications/OpenLinear.app, ~/.openlinear/OpenLinear.app |
| Linux | ~/.openlinear/openlinear, ~/.openlinear/openlinear.AppImage |
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
GitHub Commands
All GitHub auth commands use local-only flows. No hosted callback server is required.
| Command | Description |
|---|
openlinear github login | Authenticate with GitHub (auto-selects best method) |
openlinear github login --browser | Force browser-based OAuth flow |
openlinear github login --device | Force device flow (for headless environments) |
openlinear github status | Show current auth status |
openlinear github whoami | Display authenticated GitHub username |
openlinear github logout | Remove stored credentials |
Post-Install Behavior
When you run npm install -g openlinear, the postinstall script runs automatically:
Platform detection
Identifies macOS (Apple Silicon / Intel) or Linux x64.
Binary download
Downloads the latest desktop release from GitHub Releases.
Installation
- macOS: Places
OpenLinear.app in ~/Applications/
- Linux: Places the AppImage in
~/.openlinear/ and registers a .desktop entry at ~/.local/share/applications/openlinear.desktop
Library API
The openlinear package also exports TypeScript utilities for programmatic use:
| Entry point | Contents |
|---|
openlinear | Re-exports everything below |
openlinear/types | Zod schemas, validation functions for execution metadata |
openlinear/validation | Payload sanitization and forbidden-field utilities |
openlinear/config | Feature flag parsing and execution mode helpers |
