swarm-tasks-ui
v0.1.4
Published
A simple kanban UI for swarm_tasks
Maintainers
Readme
swarm-tasks-ui
A simple kanban board UI for swarm_tasks.
Quick Start
Run directly with npx (no installation required):
npx swarm-tasks-uiThis will:
- Look for a
tasksdirectory in the current folder - Start a backend server on port 3001
- Start the UI on port 5173
- Open your browser automatically
Installation
Install globally:
npm install -g swarm-tasks-uiThen run from any project:
swarm-tasks-uiUsage
Basic Usage
In a directory with a tasks folder:
swarm-tasks-uiOptions
swarm-tasks-ui [options]
Options:
-p, --port <port> Backend server port (default: 3001)
-u, --ui-port <port> UI server port (default: 5173)
--no-open Don't open browser automatically
-d, --dir <path> Tasks directory path (default: ./tasks)
-h, --help Display helpExamples
Use a different tasks directory:
swarm-tasks-ui -d ../my-project/tasksUse different ports:
swarm-tasks-ui -p 4000 -u 8080Don't open browser:
swarm-tasks-ui --no-openProject Structure
The tool expects a tasks directory with subdirectories for each state:
tasks/
├── backlog/
│ ├── task-1.md
│ └── task-2.md
├── active/
│ └── task-3.md
├── blocked/
└── completed/
└── task-4.mdEach task is a markdown file with YAML frontmatter:
---
id: unique-task-id
title: Task Title
priority: high
category: features
estimated_hours: 8
---
Task description in markdown...Features
- 📋 Kanban Board: Visual task management with drag & drop
- 🔄 Real-time Sync: Changes are saved to your file system
- 🏷️ Task Metadata: Priority, category, time estimates
- 📝 Markdown Support: Task descriptions in markdown
- 🚀 Zero Config: Works out of the box
Integration with swarm_tasks
This UI is designed to work seamlessly with the swarm_tasks CLI:
# CLI commands still work
swarm-tasks list
swarm-tasks move task-id active
# Or use the UI
swarm-tasks-uiDevelopment
Clone and install dependencies:
git clone https://github.com/bborn/swarm-tasks-ui
cd swarm-tasks-ui
npm installRun in development mode:
npm run dev # Run UI dev server
npm run server # Run backend serverBuild for production:
npm run buildLicense
MIT
