Quickstart

Prerequisites

Node.js 22.13.0 or later for the npm CLI package
A terminal in a Git repository for automatic Project and Workspace attribution
Windows 10 or 11, Python 3.10+, and Foundry Local for the current desktop app dependency path

Install the CLI

npm install -g taskbean

Confirm the install:

bean --version

Record a task

bean add "Document the authentication flow"
bean list
bean start 1
bean done 1
bean report --date today

Taskbean resolves the current Workspace and rolls the task up to its Project.

Install the Agent Skill

For GitHub Copilot:

bean install --agent copilot

To install for supported agent CLIs found on your PATH:

bean install --agent auto

See Agent Skill for detection behavior, agent-specific installs, global installs, and sandbox configuration.

Launch the desktop app

From a clone of taskbean/taskbean, use the Windows launcher:

cd app
.\launch.ps1

Or start the Python backend directly:

cd app/agent
pip install -r requirements.txt
python main.py

Open http://127.0.0.1:8275. The app reads the same ~/.taskbean/taskbean.db file as the CLI.

The first local model download can take several minutes. Check GET /api/health for process state and GET /api/ready for model readiness.

Last modified on October 14, 2026