Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/workflows/checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ name: Checks
on: [push, pull_request]
permissions:
contents: read
concurrency:
group: threadboard-checks-${{ github.ref }}
cancel-in-progress: true
jobs:
verify:
runs-on: ubuntu-latest
Expand All @@ -17,6 +20,8 @@ jobs:
- run: npm ci
- run: npm run typecheck
- run: npm run build
# Gzip byte counts in build-info vary with Node's zlib version.
- run: git diff --exit-code -- plugins/threadboard/dist THIRD_PARTY_NOTICES.md ':(exclude)plugins/threadboard/dist/build-info.json'
- run: npm test
- run: npx playwright install --with-deps chromium
- run: npm run test:ui
Expand Down
12 changes: 9 additions & 3 deletions .github/workflows/website.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ name: Website
on:
push:
branches: [main]
paths: ['site/**', 'src/ui/**', 'src/types.ts', 'docs/images/**', 'plugins/threadboard/**', 'scripts/release.mjs', 'package.json', '.github/workflows/website.yml']
paths: ['site/**', 'src/**', 'docs/**', 'plugins/threadboard/**', 'scripts/**', '*.json', '*.md', 'LICENSE', '.agents/**', '.github/workflows/website.yml']
pull_request:
paths: ['site/**', 'src/ui/**', 'src/types.ts', 'docs/images/**', 'plugins/threadboard/**', 'scripts/release.mjs', 'package.json', '.github/workflows/website.yml']
paths: ['site/**', 'src/**', 'docs/**', 'plugins/threadboard/**', 'scripts/**', '*.json', '*.md', 'LICENSE', '.agents/**', '.github/workflows/website.yml']
permissions:
contents: read
concurrency:
Expand All @@ -22,7 +22,13 @@ jobs:
with:
node-version-file: site/.node-version
cache: npm
cache-dependency-path: site/package-lock.json
cache-dependency-path: |
package-lock.json
site/package-lock.json
- run: npm ci
working-directory: .
- run: npm run build
working-directory: .
- run: npm ci
- run: npx playwright install --with-deps chromium
- run: npm test
10 changes: 5 additions & 5 deletions PRIVACY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

Last updated: 4 October 2026.

Threadboard's first release is a fully local Codex plugin. It operates a stdio MCP server and an embedded board. It has no hosted service, login, analytics, advertisements, telemetry, or model API integration. Its runtime makes no outbound network requests.
Threadboard is a local Codex plugin. It operates a stdio MCP server and an embedded board. It has no hosted service, login, analytics, advertisements, telemetry, or model API integration. Its runtime makes no outbound network requests.

## Local data

The plugin stores native project IDs, names and canonical workspace paths; named boards, their companion chat IDs and setup request IDs; task titles, descriptions, acceptance criteria, priorities and states; prerequisites; deliberate activity notes; and task ownership handles. When supplied explicitly, a native Codex chat ID is stored to enable an Open chat link. Claim tokens are hashed in storage. The plugin does not open Codex transcript files, query chat-content tables, copy conversation history, or read repository file contents. A task's workspace directory is checked for existence before a new-chat launch.
The plugin stores native project IDs, names and canonical workspace paths; named boards, their companion chat IDs and setup request IDs; task titles, descriptions, acceptance criteria, priorities and states; prerequisites; activity notes; and task ownership handles. When supplied explicitly, a native Codex chat ID is stored to enable an Open chat link. Claim tokens are hashed in storage. The plugin does not open Codex transcript files, query chat-content tables, copy conversation history, or read repository file contents. A task's workspace directory is checked for existence before a new-chat launch.

The working-tree preview discovers projects from Codex's local metadata. Its read-only adapter extracts only project IDs, names, and root paths from the desktop state file, excluding ChatGPT cloud project mirrors. Unrelated desktop state is not returned or stored. Threadboard never modifies this source and does not open Codex's conversation database. Project metadata remains local, alongside task data. The published 0.1.1 release instead uses manually associated workspace boards.
The repository and website preview discovers projects from Codex's local metadata. Its read-only adapter extracts only project IDs, names, and root paths from the desktop state file, excluding ChatGPT cloud project mirrors. Unrelated desktop state is not returned or stored. Threadboard never modifies this source and does not open Codex's conversation database. Project metadata remains local, alongside task data. The published 0.1.1 release instead uses manually associated workspace boards.

While the board is visible, its embedded UI checks an opaque local revision token once per second and reloads local board data only after changes. Checks pause for hidden documents and panels, with retries backing off after failures. These app-only MCP checks contain no task or chat content, do not start model turns, and do not upload or sync conversations. Task states reflect explicit Threadboard tool updates; the plugin does not monitor chat transcripts.

Expand All @@ -20,9 +20,9 @@ Task information returned by MCP tools can become context in a Codex chat. Selec

## Export and removal

Export creates a local JSON snapshot with task content, all deliberate activity notes, workspace paths, prerequisites, and current chat/run references. It does not upload the snapshot or export chat transcripts. JSON import is not provided in this release. Keep exports private if they contain private project information.
Export creates a local JSON snapshot with task content, all activity notes, workspace paths, prerequisites, and current chat/run references. It does not upload the snapshot or export chat transcripts. JSON import is not provided in this release. Keep exports private if they contain private project information.

Archiving a card preserves it for restoration. Uninstalling the plugin preserves the database. To remove all Threadboard data, first stop the plugin and delete its application data directory using your operating system's file manager. See README.md for the platform-specific locations and backup instructions.
Archiving a card preserves it for restoration. Uninstalling the plugin preserves the database. To remove all Threadboard data, first stop the plugin and delete its application data directory using your operating system's file manager. See [the user guide](docs/usage.md#data-and-updates) for platform-specific locations and backup instructions.

## Support

Expand Down
57 changes: 26 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,64 +1,59 @@
<img src="docs/images/cover-dark.svg#gh-dark-mode-only" alt="Threadboard — Give every task a home. Local boards for your Codex projects." width="1200">
<img src="docs/images/cover.svg#gh-light-mode-only" alt="Threadboard — Give every task a home. Local boards for your Codex projects." width="1200">
<img src="docs/images/cover-dark.svg#gh-dark-mode-only" alt="Threadboard — Task boards inside Codex" width="1200">
<img src="docs/images/cover.svg#gh-light-mode-only" alt="Threadboard — Task boards inside Codex" width="1200">

Plan work across your Codex projects, give each task a chat, and bring the result back for review. Threadboard keeps your boards on your device and opens inside Codex.
Threadboard adds local task boards to Codex. Plan work in your existing projects, assign cards to chats, and review the results before marking them Done.

[Product page and preview download](https://threadboard.vrnrn.com/) · **Current source preview: `0.1.4-dev.6`** · [Installation](#install-the-current-preview) · [User guide](docs/usage.md) · [Development](docs/development.md) · [MIT license](LICENSE)
[Website and interactive demo](https://threadboard.vrnrn.com/) · [Install](#install-the-current-preview) · [User guide](docs/usage.md) · [Development](docs/development.md) · [Release notes](RELEASE_NOTES.md)

<img src="docs/images/board-dark.png#gh-dark-mode-only" alt="Orbit's Product board, with tasks across Backlog, Ready, In progress, Review, and Done" width="1512">
<img src="docs/images/board.png#gh-light-mode-only" alt="Orbit's Product board, with tasks across Backlog, Ready, In progress, Review, and Done" width="1512">

## From plan to review
## What it does

- **Your Codex projects.** Existing local projects appear automatically, each with an empty General board. Create and manage projects in Codex.
- **Room for more than one board.** Organize a project into named boards such as Product, Release, and Editorial. The overview shows every board and its task counts.
- **Work shared across chats.** Pick up a card in an existing chat or start a new chat from it. Atomic ownership keeps one chat responsible for the work.
- **Results come back for review.** Read deliberate progress notes, review the result, and explicitly accept it into Done or request changes.
- **Lightweight live updates.** Visible boards check a small local revision once per second and reload only after changes. Hidden panels pause; open drafts are preserved.
- **A familiar surface.** The board follows Codex's theme and font settings, supports keyboard navigation, and adapts to narrower panels.
- **Uses your Codex projects.** Each gets a General board. Add named boards for features, releases, or other work.
- **Connects tasks to chats.** Start a new chat from a card or ask an existing chat to claim it. One chat owns a task at a time.
- **Keeps the result on the card.** Chats add progress notes and submit work to Review. You accept it into Done or request changes.
- **Updates as you work.** Visible boards check for local changes. Hidden panels pause, and refreshes preserve open drafts.
- **Fits inside Codex.** Host themes, keyboard controls, and layouts for narrow panels are supported.

Task content stays in a local SQLite database. The plugin uses a bundled stdio MCP server, with no hosted backend or transcript synchronization. Using task information in Codex still uses your normal Codex account and model allowance. [Privacy details](PRIVACY.md).
Boards live in a local SQLite database. The plugin has no hosted backend, telemetry, or transcript access. Task information used in a chat goes through your normal Codex account and model service. [Privacy details](PRIVACY.md).

<table>
<tr>
<td width="50%" valign="top"><strong>Every project, every board</strong><br><br><img src="docs/images/overview-dark.png#gh-dark-mode-only" alt="The Your boards overview groups General, Product, Release, and Editorial boards by project"><img src="docs/images/overview.png#gh-light-mode-only" alt="The Your boards overview groups General, Product, Release, and Editorial boards by project"></td>
<td width="50%" valign="top"><strong>Review, then move forward</strong><br><br><img src="docs/images/task-review-dark.png#gh-dark-mode-only" alt="A task in Review with its goal, acceptance criteria, owner notes, and explicit acceptance controls"><img src="docs/images/task-review.png#gh-light-mode-only" alt="A task in Review with its goal, acceptance criteria, owner notes, and explicit acceptance controls"></td>
<td width="50%" valign="top"><strong>Projects and boards</strong><br><br><img src="docs/images/overview-dark.png#gh-dark-mode-only" alt="Boards grouped by Codex project"><img src="docs/images/overview.png#gh-light-mode-only" alt="Boards grouped by Codex project"></td>
<td width="50%" valign="top"><strong>Task review</strong><br><br><img src="docs/images/task-review-dark.png#gh-dark-mode-only" alt="A task's goal, checks, activity, and review controls"><img src="docs/images/task-review.png#gh-light-mode-only" alt="A task's goal, checks, activity, and review controls"></td>
</tr>
</table>

*Product captures use isolated demonstration data. [More screenshots and editable graphics](docs/graphics.md).*
Screenshots use example projects. [More captures and editable artwork](docs/graphics.md).

## Install the current preview

You need a Codex desktop version with plugin/MCP App entrypoints, the Codex CLI, and **Node.js 22.13 or newer**.
Requires **Codex desktop with plugin/MCP App support**, the **Codex CLI**, and **Node.js 22.13 or newer**.

```sh
codex plugin marketplace add vrnrn/Threadboard --ref main
codex plugin add threadboard@threadboard-plugins
```

Fully quit and reopen Codex, then open **Threadboard** from the sidebar. Your existing projects and boards appear in **Your boards**. Repository installation uses `node` from Codex's PATH; the source includes compiled assets, so consumers do not need npm or a build step.
Fully quit and reopen Codex, then open **Threadboard** from the sidebar. The repository includes compiled assets; no npm install or build step is needed. Node must be available on Codex's PATH.

### Install a release

The latest downloadable package is still [the `0.1.1` preview](https://github.com/vrnrn/Threadboard/releases/tag/v0.1.1). It uses manual workspace association and manual refresh; it predates the native project discovery, named boards, and live updates shown above.
You can also [download the website preview](https://threadboard.vrnrn.com/#install), extract the ZIP, and run `node install.mjs` from that folder. The installer checks the package, finds Node, and preserves existing task data during updates.

Download its ZIP, extract it, and run `node install.mjs`. The installer discovers Node, verifies checksums, and keeps plugin files separate from task storage. Reopen Codex and follow that release's included README. Installing a newer package preserves task data.

## A few useful details
### Install a release

A new card chat opens with a prefilled prompt: **send it to begin**. Creating a named board can also request a companion chat named `<board name> Threadboard` through Codex's native project-aware tools. Threadboard stores the chat reference and deliberate task state, without reading conversation history.
The older [GitHub release, 0.1.1](https://github.com/vrnrn/Threadboard/releases/tag/v0.1.1), uses manual workspace association and refresh. Use the website or repository preview for the native projects, named boards, and live updates shown here.

If Codex leaves the board in a split pane after Back, **Open full view** beside Refresh requests the sidebar app and carries the selected project, board, and archive view. Codex owns its navigation and pane layout; this new recovery control still needs native-host verification.
## Using the board

Shortcuts: **N** creates a task, **⌘/Ctrl K** focuses search, and **Escape** closes a dialog. [The user guide](docs/usage.md) covers board navigation, claims, companion chats, exports, backups, and removal.
Open a card and choose **Start in new chat**, then **send the prepared prompt** in Codex to begin. A named board can also have a companion chat. [The user guide](docs/usage.md) covers ownership, review, exports, backups, and recovery.

## Build and contribute
**N** creates a task, **⌘/Ctrl K** focuses search, and **Escape** closes a dialog. Search covers loaded cards; boards with more than 200 tasks offer **Load more tasks**.

See [the development guide](docs/development.md) for local setup, tests, performance checks, packaging, and installation verification. Regenerate the current product captures and social artwork with `npm run graphics`.
This is preview software. Native board opening has been tested locally. Card-launch project placement, sidebar icons after a host restart, and **Open full view** recovery still need native-host verification. Browser tests cannot confirm Codex's window layout. Threadboard is independently distributed and is not listed in OpenAI's universal directory.

Native board opening has been confirmed locally. The preview's browser workflows, packaged MCP execution, and clean installation are tested; card-launch project placement and the full-view recovery control have separate native-host checks remaining. Threadboard is independently distributed through its repository marketplace; it has not been submitted to OpenAI's universal directory.
## Development

The design was inspired by [Cline Kanban](https://github.com/cline/kanban); this implementation is original. [Release notes](RELEASE_NOTES.md) track shipped and source previews. [The vision](https://github.com/vrnrn/Threadboard/blob/main/VISION.md) and [architecture](https://github.com/vrnrn/Threadboard/blob/main/ARCHITECTURE.md) describe the longer-term product.
See [development and verification](docs/development.md) for builds, tests, benchmarks, and packaging. The website lives in [`site/`](site/README.md). Run `npm run graphics` to update product screenshots and repository artwork.

MIT licensed. Bundled dependencies retain their own licenses in [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md). [Report a bug](https://github.com/vrnrn/Threadboard/issues).
Inspired by [Cline Kanban](https://github.com/cline/kanban). MIT licensed; bundled dependency licenses are in [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md). [Report a bug](https://github.com/vrnrn/Threadboard/issues).
12 changes: 12 additions & 0 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# Release notes

## Unreleased — 0.1.4-dev.8

- Collect each dependency license once on both case-sensitive and case-insensitive filesystems.

- Delayed task reads no longer replace a newer card or reopen a closed dialog. Manual refresh preserves loaded pages, and pagination retries when the board changes between reads.
- Moving or reordering a task within its current column preserves its prepared chat. Launch binding rechecks blockers and prerequisites. Review cards consistently show their most recent submission.
- Dialogs make background controls inactive. Task shortcuts respect modifier keys, and cancelling a drag resumes live updates.
- Website and repository copy is shorter, installation links point to the current preview, and artwork uses a consistent neutral palette. Small-screen explanatory text is larger; obsolete screenshot styles are removed.
- The website demo matches task ownership and activity ordering in the app, and its transport is included in TypeScript checks.
- Project metadata refresh skips unchanged database rows. Installer failures clean up their staging directory. CI checks compiled assets and all website package inputs.


## Current source and website preview — 0.1.4-dev.7

The three-line Threadboard icon now appears in the package's light and dark assets and in MCP server/tool discovery for the sidebar app. The icon is embedded locally and needs no remote asset. Close Threadboard and fully quit and reopen Codex after updating so the host reloads discovery metadata.
Expand Down
Loading
Loading