Skip to content
Home
Tasklynx
Github.com

Tasklynx Documentation

Tasklynx is a local-first task manager for developers. It combines a scriptable CLI, an interactive terminal Kanban board, and a small web dashboard on top of a single JSON store — with Git-style branches for parallel work.

Current release

v0.0.1-b4 is the current prerelease. It includes:

  • Git-aware branches, commit/PR/issue links, TODO scanning, and opt-in commit trailers.
  • Optional AI plan, breakdown, triage, standup, review, and ask commands that preview before writing (provider support requires a source build).
  • Recurring tasks, dependencies, subtasks, saved views, bulk completion, undo, and trash.
  • Local time tracking, due-date reminders, and JSON, Markdown, or iCalendar export.
  • CLI, terminal Kanban board, and web dashboard with an AI copilot panel.

See the changelog for release details.

Start here

Guide What it covers
Getting Started Install, initialize, and complete your first task
Installation Every install method, updates, and uninstall
CLI Reference Commands, flags, and examples
Configuration Config file, data paths, saved views, Git, and AI
Git Integration Branch mapping, commit links, scanning, and hooks
AI Setup Providers, privacy controls, and the optional ai feature

Understand the project

Guide What it covers
Architecture Modules, data flow, Git, AI, and storage design
Development Build, test, and release workflow
Deployment Release artifacts, Pages, and containers

Help

Guide What it covers
Troubleshooting Common problems and fixes
FAQ Frequently asked questions
Screenshots Interface previews

At a glance

# Install (Linux, macOS, Termux)
curl -fsSL https://raw.githubusercontent.com/peekstore/tasklynx/main/installer.sh | sh

# Create and track your first task
tx init
TASK_ID=$(tx add "Ship the prerelease" --priority high --due 2026-12-31 --estimate 120)
tx start "$TASK_ID"
tx next --explain
tx complete "$TASK_ID"
tx agenda --days 14
tx board

Back to README