Skip to content

Commit 26a29ae

Browse files
committed
docs: update README to remove outdated docker isolation and tauri refs
1 parent 957b614 commit 26a29ae

2 files changed

Lines changed: 22 additions & 29 deletions

File tree

README.md

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
# OpenLinear
44

5-
**AI-powered project management that actually writes the code.**
5+
**A kanban board that executes your tasks.**
66

7-
Drag tasks on a kanban board. Click execute. Get a pull request.
7+
Describe what you want built. Click execute. Get a pull request.
88

99
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
1010
[![Node](https://img.shields.io/badge/node-%3E%3D22-brightgreen)](https://nodejs.org)
@@ -20,23 +20,20 @@ Drag tasks on a kanban board. Click execute. Get a pull request.
2020

2121
## What is OpenLinear?
2222

23-
OpenLinear is a **desktop app** (built with Tauri) that combines a Linear-style kanban board with AI coding agents. You manage tasks visually, and when you're ready, the AI clones your repo, creates a branch, writes the code, and opens a pull request — all in one click.
23+
OpenLinear is a project management tool that turns your backlog into pull requests. You manage tasks on a Linear-style kanban board. When you're ready, an AI agent — running locally with your own credentials — clones your repo, creates a branch, writes the code, and opens a PR. No copy-pasting prompts, no context switching.
2424

25-
Each user gets an **isolated Docker container** running their own AI agent with their own API keys. No credential sharing, no interference between users.
26-
27-
**Architecture:** The dashboard is **desktop-only**. The web version only contains the marketing landing page.
25+
The dashboard is **desktop-only**. The web version only contains the marketing landing page.
2826

2927
## Features
3028

3129
- **Kanban Board** — drag-and-drop task management with priorities, labels, and status tracking
3230
- **One-Click Execution** — select a task, hit execute, get a PR with real code changes
3331
- **Batch Execution** — run multiple tasks in parallel or queue mode, merged into a single PR
34-
- **Container Isolation**every user gets a dedicated Docker container with isolated credentials
32+
- **Local Execution**agent runs on your machine with your own API keys and credentials
3533
- **Real-Time Streaming** — watch the AI work live via SSE (tool calls, file edits, progress)
3634
- **GitHub Integration** — OAuth login, repo management, automatic PR creation
3735
- **Brainstorm Mode** — describe a goal in natural language, get actionable tasks generated
3836
- **Teams & Projects** — organize work with teams, projects, and scoped issue numbering
39-
- **Desktop App** — runs as a Tauri desktop app with native performance
4037

4138
## Agent Support
4239

@@ -53,7 +50,7 @@ Each user gets an **isolated Docker container** running their own AI agent with
5350

5451
- Node.js 22+
5552
- pnpm 9+
56-
- Docker
53+
- Docker (for PostgreSQL only)
5754
- A GitHub OAuth app (for login and repo access)
5855

5956
### Setup
@@ -89,16 +86,14 @@ pnpm --filter @openlinear/desktop dev
8986
| `GITHUB_CLIENT_ID` | GitHub OAuth app client ID |
9087
| `GITHUB_CLIENT_SECRET` | GitHub OAuth app client secret |
9188
| `GITHUB_REDIRECT_URI` | OAuth callback URL |
92-
| `OPENCODE_IMAGE` | Docker image for worker containers (default: `opencode-worker:latest`) |
93-
| `REPOS_DIR` | Host path for cloned repos (default: `/tmp/openlinear-repos`) |
9489
| `API_PORT` | API server port (default: `3001`) |
9590
| `CORS_ORIGIN` | Allowed CORS origin (default: `http://localhost:3000`) |
9691

9792
## How It Works
9893

9994
1. **You create tasks** on the kanban board with descriptions of what you want built
100-
2. **You click execute** — the API clones your repo, creates a branch, and spins up an AI agent
101-
3. **The agent writes code** in an isolated Docker container with its own git worktree
95+
2. **You click execute** — the desktop app picks it up, clones your repo, and creates a branch
96+
3. **The agent writes code** locally using your API keys, in its own git worktree
10297
4. **You watch it work** — real-time SSE streams every tool call, file edit, and decision
10398
5. **You get a PR** — changes are committed, pushed, and a pull request is created automatically
10499

@@ -111,14 +106,14 @@ For batch execution, multiple tasks run in parallel (or queued), each in isolate
111106
```
112107
openlinear/
113108
apps/
114-
desktop-ui/ Next.js frontend (Tauri webview) - DESKTOP ONLY
115-
desktop/ Tauri app shell
109+
desktop-ui/ Next.js frontend (desktop webview)
110+
desktop/ Desktop app shell
116111
landing/ Marketing landing page (Vercel)
117-
api/ Express API sidecar
112+
api/ Express API
118113
packages/
119114
db/ Prisma schema + client
120-
docker/
121-
opencode-worker/ Per-user container image
115+
openlinear/ npm package (CLI launcher + library)
116+
types/ Shared TypeScript types
122117
docs/
123118
features/ Feature documentation (18 guides)
124119
diagrams/ Architecture SVGs
@@ -132,7 +127,7 @@ openlinear/
132127
| AppImage | Linux | [GitHub Releases](https://github.com/kaizen403/openlinear/releases) |
133128
| .deb | Debian/Ubuntu | [GitHub Releases](https://github.com/kaizen403/openlinear/releases) |
134129
| AUR | Arch Linux | `yay -S openlinear-bin` |
135-
| npm installer | Any | `npm install -g @kaizen403/openlinear` |
130+
| npm installer | Any | `npm install -g openlinear` |
136131

137132
Release builds are triggered automatically on tag push (`v*`).
138133

packages/openlinear/README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
# OpenLinear
44

5-
**AI-powered project management that actually writes the code.**
5+
**A kanban board that executes your tasks.**
66

7-
Drag tasks on a kanban board. Click execute. Get a pull request.
7+
Describe what you want built. Click execute. Get a pull request.
88

99
[![npm version](https://img.shields.io/npm/v/openlinear.svg)](https://www.npmjs.com/package/openlinear)
1010
[![npm downloads](https://img.shields.io/npm/dm/openlinear.svg)](https://www.npmjs.com/package/openlinear)
@@ -20,9 +20,7 @@ Drag tasks on a kanban board. Click execute. Get a pull request.
2020

2121
## What is OpenLinear?
2222

23-
OpenLinear is a **desktop app** (built with Tauri) that combines a Linear-style kanban board with AI coding agents. You manage tasks visually, and when you're ready, the AI clones your repo, creates a branch, writes the code, and opens a pull request — all in one click.
24-
25-
Each user gets an **isolated Docker container** running their own AI agent with their own API keys. No credential sharing, no interference between users.
23+
OpenLinear is a project management tool that turns your backlog into pull requests. You manage tasks on a Linear-style kanban board. When you're ready, an AI agent — running locally with your own credentials — clones your repo, creates a branch, writes the code, and opens a PR. No copy-pasting prompts, no context switching.
2624

2725
**This package** is the official launcher and utility library. It does two things:
2826

@@ -349,8 +347,8 @@ Any payload passing through `sanitizePayload` or `safeValidateExecutionMetadataS
349347
## How OpenLinear Works
350348

351349
1. **You create tasks** on the kanban board with descriptions of what you want built.
352-
2. **You click execute** — the API clones your repo, creates a branch, and spins up a dedicated AI agent container.
353-
3. **The agent writes code** in an isolated Docker container with its own git worktree and credentials.
350+
2. **You click execute** — the desktop app picks it up, clones your repo, and creates a branch.
351+
3. **The agent writes code** locally using your API keys, in its own git worktree.
354352
4. **You watch it work** — real-time SSE streams every tool call, file edit, and decision live.
355353
5. **You get a PR** — changes are committed, pushed, and a pull request is opened automatically.
356354

@@ -368,8 +366,8 @@ pnpm install
368366
# Build the npm package
369367
pnpm --filter openlinear build
370368

371-
# Build the full desktop app
372-
docker compose up -d
369+
# Start the full stack
370+
docker compose up -d # PostgreSQL only
373371
pnpm db:push
374372
pnpm --filter @openlinear/api dev
375373
pnpm --filter @openlinear/desktop dev
@@ -404,4 +402,4 @@ pnpm test # run tests
404402

405403
## License
406404

407-
[MIT](https://github.com/kaizen403/openlinear/blob/main/LICENSE)
405+
[MIT](https://github.com/kaizen403/openlinear/blob/main/LICENSE)

0 commit comments

Comments
 (0)