backlog.md 1.15.2 β 1.16.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +127 -53
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -17,20 +17,20 @@
|
|
|
17
17
|
|
|
18
18
|
* π **Markdown-native tasks** -- manage every issue as a plain `.md` file
|
|
19
19
|
|
|
20
|
-
*
|
|
20
|
+
* π€ **AI-Ready** -- Works with Claude Code, Gemini CLI, Codex & any other MCP or CLI compatible AI assistants
|
|
21
21
|
|
|
22
22
|
* π **Instant terminal Kanban** -- `backlog board` paints a live board in your shell
|
|
23
23
|
|
|
24
|
-
* π€ **Board export** -- `backlog board export` creates shareable markdown reports
|
|
25
|
-
|
|
26
24
|
* π **Modern web interface** -- `backlog browser` launches a sleek web UI for visual task management
|
|
27
25
|
|
|
28
|
-
* π€ **AI-ready CLI** -- "Claude, please take over task 33"
|
|
29
|
-
|
|
30
26
|
* π **Powerful search** -- fuzzy search across tasks, docs & decisions with `backlog search`
|
|
31
27
|
|
|
32
28
|
* π **Rich query commands** -- view, list, filter, or archive tasks with ease
|
|
33
29
|
|
|
30
|
+
* π€ **Board export** -- `backlog board export` creates shareable markdown reports
|
|
31
|
+
|
|
32
|
+
* π **100 % private & offline** -- backlog lives entirely inside your repo and you can manage everything locally
|
|
33
|
+
|
|
34
34
|
* π» **Cross-platform** -- runs on macOS, Linux, and Windows
|
|
35
35
|
|
|
36
36
|
* π **MIT-licensed & open-source** -- free for personal or commercial use
|
|
@@ -40,35 +40,35 @@
|
|
|
40
40
|
|
|
41
41
|
## <img src="./.github/5-minute-tour-256.png" alt="5-minute tour" width="28" height="28" align="center"> Fiveβminute tour
|
|
42
42
|
```bash
|
|
43
|
-
# 1. Make sure you have Backlog.md installed
|
|
44
|
-
bun
|
|
45
|
-
|
|
46
|
-
|
|
43
|
+
# 1. Make sure you have Backlog.md installed (global installation recommended)
|
|
44
|
+
bun i -g backlog.md
|
|
45
|
+
or
|
|
46
|
+
npm i -g backlog.md
|
|
47
|
+
or
|
|
48
|
+
brew install backlog-md
|
|
49
|
+
|
|
50
|
+
# 2. Bootstrap a repo + backlog and choose the AI Agent integration mode (MCP, CLI, or skip)
|
|
47
51
|
backlog init "My Awesome Project"
|
|
48
52
|
|
|
49
|
-
# 3.
|
|
53
|
+
# 3. Create tasks manually
|
|
50
54
|
backlog task create "Render markdown as kanban"
|
|
51
55
|
|
|
52
|
-
# 4.
|
|
53
|
-
backlog board view or backlog browser
|
|
54
|
-
|
|
55
|
-
# 5. Find what you need
|
|
56
|
-
backlog search "markdown" or just backlog search for interactive filters
|
|
57
|
-
|
|
58
|
-
# 6. Create tasks using Claude-code, Gemini, Codex or Jules
|
|
56
|
+
# 4. Or ask AI to create them: Claude Code, Gemini CLI, or Codex (Agents automatically use Backlog.md via MCP or CLI)
|
|
59
57
|
Claude I would like to build a search functionality in the web view that searches for:
|
|
60
58
|
* tasks
|
|
61
59
|
* docs
|
|
62
60
|
* decisions
|
|
63
61
|
Please create relevant tasks to tackle this request.
|
|
64
62
|
|
|
65
|
-
#
|
|
63
|
+
# 5. See where you stand
|
|
64
|
+
backlog board view or backlog browser
|
|
65
|
+
|
|
66
|
+
# 6. Assign tasks to AI (Backlog.md instructions tell agents how to work with tasks)
|
|
66
67
|
Claude please implement all tasks related to the web search functionality (task-10, task-11, task-12)
|
|
67
|
-
* before starting to write code use 'ultrathink mode' to prepare an implementation plan
|
|
68
|
+
* before starting to write code use 'ultrathink mode' to prepare and add an implementation plan to the task
|
|
68
69
|
* use multiple sub-agents when possible and dependencies allow
|
|
69
70
|
```
|
|
70
71
|
|
|
71
|
-
|
|
72
72
|
All data is saved under `backlog` folder as humanβreadable Markdown with the following format `task-<task-id> - <task-title>.md` (e.g. `task-10 - Add core search functionality.md`).
|
|
73
73
|
|
|
74
74
|
---
|
|
@@ -88,16 +88,71 @@ backlog browser --port 8080
|
|
|
88
88
|
backlog browser --no-open
|
|
89
89
|
```
|
|
90
90
|
|
|
91
|
+
**Features:**
|
|
92
|
+
- Interactive Kanban board with drag-and-drop
|
|
93
|
+
- Task creation and editing with rich forms
|
|
94
|
+
- Interactive acceptance criteria editor with checklists
|
|
95
|
+
- Real-time updates across all views
|
|
96
|
+
- Responsive design for desktop and mobile
|
|
97
|
+
- Task archiving with confirmation dialogs
|
|
98
|
+
- Seamless CLI integration - all changes sync with markdown files
|
|
99
|
+
|
|
91
100
|
|
|
92
101
|
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
102
|
+
---
|
|
103
|
+
|
|
104
|
+
## π§ MCP Integration (Model Context Protocol)
|
|
105
|
+
|
|
106
|
+
Connect Backlog.md to an MCP-compatible AI tool so it can launch `backlog mcp start` automatically whenever it needs project access.
|
|
107
|
+
|
|
108
|
+
### Client guides
|
|
109
|
+
|
|
110
|
+
<details>
|
|
111
|
+
<summary><strong>Claude Code</strong></summary>
|
|
112
|
+
|
|
113
|
+
```bash
|
|
114
|
+
claude mcp add my-project-backlog -- backlog mcp start
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
</details>
|
|
118
|
+
|
|
119
|
+
<details>
|
|
120
|
+
<summary><strong>Codex</strong></summary>
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
codex mcp add my-project-backlog -- backlog mcp start
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
</details>
|
|
127
|
+
|
|
128
|
+
<details>
|
|
129
|
+
<summary><strong>Gemini CLI</strong></summary>
|
|
130
|
+
|
|
131
|
+
```bash
|
|
132
|
+
gemini mcp add my-project-backlog backlog mcp start
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
</details>
|
|
136
|
+
|
|
137
|
+
### Manual config
|
|
138
|
+
|
|
139
|
+
```json
|
|
140
|
+
{
|
|
141
|
+
"mcpServers": {
|
|
142
|
+
"my-project-backlog": {
|
|
143
|
+
"command": "backlog",
|
|
144
|
+
"args": ["mcp", "start"]
|
|
145
|
+
},
|
|
146
|
+
"my-other-project-backlog": {
|
|
147
|
+
"command": "backlog",
|
|
148
|
+
"args": ["mcp", "start"]
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
Once connected, agents can read the Backlog.md workflow instructions via the resource `backlog://docs/task-workflow`.
|
|
155
|
+
Use `/mcp` command in your AI tool (Claude Code, Codex) to verify if the connection is working.
|
|
101
156
|
|
|
102
157
|
---
|
|
103
158
|
|
|
@@ -113,7 +168,8 @@ The web interface provides:
|
|
|
113
168
|
|
|
114
169
|
`backlog init` keeps first-run setup focused on the essentials:
|
|
115
170
|
- **Project name** β identifier for your backlog (defaults to the current directory on re-run).
|
|
116
|
-
- **
|
|
171
|
+
- **Integration choice** β decide whether your AI tools connect through the **MCP connector** (recommended) or stick with **CLI commands (legacy)**.
|
|
172
|
+
- **Instruction files (CLI path only)** β when you choose the legacy CLI flow, pick which instruction files to create (CLAUDE.md, AGENTS.md, GEMINI.md, Copilot, or skip).
|
|
117
173
|
- **Advanced settings prompt** β default answer βNoβ finishes init immediately; choosing βYesβ jumps straight into the advanced wizard documented in [Configuration](#configuration).
|
|
118
174
|
|
|
119
175
|
You can rerun the wizard anytime with `backlog config`. All existing CLI flags (for example `--defaults`, `--agent-instructions`, or `--install-claude-agent true`) continue to provide fully non-interactive setups, so existing scripts keep working without change.
|
|
@@ -197,6 +253,24 @@ Find tasks, documents, and decisions across your entire backlog with fuzzy searc
|
|
|
197
253
|
| Draft flow | `backlog draft create "Spike GraphQL"` β `backlog draft promote 3.1` |
|
|
198
254
|
| Demote to draft| `backlog task demote <id>` |
|
|
199
255
|
|
|
256
|
+
### Dependency Management
|
|
257
|
+
|
|
258
|
+
Manage task dependencies to create execution sequences and prevent circular relationships:
|
|
259
|
+
|
|
260
|
+
| Action | Example |
|
|
261
|
+
|-------------|------------------------------------------------------|
|
|
262
|
+
| Add dependencies | `backlog task edit 7 --dep task-1 --dep task-2` |
|
|
263
|
+
| Add multiple deps | `backlog task edit 7 --dep task-1,task-5,task-9` |
|
|
264
|
+
| Create with deps | `backlog task create "Feature" --dep task-1,task-2` |
|
|
265
|
+
| View dependencies | `backlog task 7` (shows dependencies in task view) |
|
|
266
|
+
| Validate dependencies | Use task commands to automatically validate dependencies |
|
|
267
|
+
|
|
268
|
+
**Dependency Features:**
|
|
269
|
+
- **Automatic validation**: Prevents circular dependencies and validates task existence
|
|
270
|
+
- **Flexible formats**: Use `task-1`, `1`, or comma-separated lists like `1,2,3`
|
|
271
|
+
- **Visual sequences**: Dependencies create visual execution sequences in board view
|
|
272
|
+
- **Completion tracking**: See which dependencies are blocking task progress
|
|
273
|
+
|
|
200
274
|
### Board Operations
|
|
201
275
|
|
|
202
276
|
| Action | Example |
|
|
@@ -352,33 +426,33 @@ Perfect for sharing project status, creating reports, or storing snapshots in ve
|
|
|
352
426
|
|
|
353
427
|
<!-- BOARD_START -->
|
|
354
428
|
|
|
355
|
-
## π Backlog.md Project Status (v1.
|
|
429
|
+
## π Backlog.md Project Status (v1.16.0)
|
|
356
430
|
|
|
357
431
|
This board was automatically generated by [Backlog.md](https://backlog.md)
|
|
358
432
|
|
|
359
|
-
Generated on: 2025-10-
|
|
360
|
-
|
|
361
|
-
| To Do | In Progress | Done |
|
|
362
|
-
| --- | --- | --- |
|
|
363
|
-
| **TASK-276** - Implement drag mode for TUI kanban board | **TASK-280** - Fix TUI task list selection and detail pane synchronization bug [@codex]<br>*#bug #tui* | **TASK-
|
|
364
|
-
| **TASK-270** - Prevent command substitution in task creation inputs [@codex] | ββ **TASK-24.1** - CLI: Kanban board milestone view [@codex] | **TASK-
|
|
365
|
-
| **TASK-268** - Show agent instruction version status [@codex] | **TASK-273** - Refactor search [@codex]<br>*#core #search* | **TASK-
|
|
366
|
-
| **TASK-267** - Add agent instruction version metadata [@codex] | | **TASK-
|
|
367
|
-
| **TASK-260** - Web UI: Add filtering to All Tasks view [@codex]<br>*#web-ui #filters #ui* | | **TASK-
|
|
368
|
-
| **TASK-259** - Add task list filters for Status and Priority<br>*#tui #filters #ui* | | **TASK-
|
|
369
|
-
| **TASK-257** - Deep link URLs for tasks in board and list views | | **TASK-
|
|
370
|
-
| **TASK-200** - Add Claude Code integration with workflow commands during init<br>*#enhancement #developer-experience* | | **TASK-
|
|
371
|
-
| **TASK-244** - TUI: add live updates via watch in task list and kanban [@codex]<br>*#tui #watcher #enhancement* | | **TASK-
|
|
372
|
-
| **TASK-218** - Update documentation and tests for sequences<br>*#sequences #documentation #testing* | |
|
|
373
|
-
| **TASK-217** - Create web UI for sequences with drag-and-drop<br>*#sequences #web-ui #frontend* | | ββ **TASK-273.
|
|
374
|
-
| ββ **TASK-217.03** - Sequences web UI: move tasks and update dependencies<br>*#sequences* | | ββ **TASK-273.
|
|
375
|
-
| ββ **TASK-217.04** - Sequences web UI: tests<br>*#sequences* | |
|
|
376
|
-
| ββ **TASK-217.02** - Sequences web UI: list sequences<br>*#sequences* | | |
|
|
377
|
-
| **TASK-243** - Enable TUI task reordering with Shift+Arrow keys [@codex]<br>*#tui #ui #enhancement* | | |
|
|
378
|
-
| **TASK-240** - Improve binary resolution on Apple Silicon (Rosetta/arch mismatch) [@codex]<br>*#packaging #bug #macos* | | |
|
|
379
|
-
| **TASK-239** - Feature: Auto-link tasks to documents/decisions + backlinks [@codex]<br>*#web #enhancement #docs* | | |
|
|
380
|
-
| **TASK-222** - Improve task and subtask visualization in web UI | | |
|
|
381
|
-
| **TASK-208** - Add paste-as-markdown support in Web UI<br>*#web-ui #enhancement #markdown* | | |
|
|
433
|
+
Generated on: 2025-10-14 17:28:50
|
|
434
|
+
|
|
435
|
+
| To Do | In Progress | Done |
|
|
436
|
+
| --- | --- | --- |
|
|
437
|
+
| **TASK-276** - Implement drag mode for TUI kanban board | **TASK-280** - Fix TUI task list selection and detail pane synchronization bug [@codex]<br>*#bug #tui* | **TASK-284** - Simplify init flow; launch advanced settings via backlog config [@codex]<br>*#cli #init #config* |
|
|
438
|
+
| **TASK-270** - Prevent command substitution in task creation inputs [@codex] | ββ **TASK-24.1** - CLI: Kanban board milestone view [@codex] | **TASK-287** - Add MCP support for agent integration [@codex]<br>*#mcp #integration #agent* |
|
|
439
|
+
| **TASK-268** - Show agent instruction version status [@codex] | **TASK-273** - Refactor search [@codex]<br>*#core #search* | **TASK-286** - Add npm script and shell script for updating bun.nix via Docker [@myself]<br>*#tooling #nix #ci* |
|
|
440
|
+
| **TASK-267** - Add agent instruction version metadata [@codex] | | **TASK-285** - adjust z-index tooltip style |
|
|
441
|
+
| **TASK-260** - Web UI: Add filtering to All Tasks view [@codex]<br>*#web-ui #filters #ui* | | **TASK-283** - Fix TUI board duplicating cards after external status changes [@codex] |
|
|
442
|
+
| **TASK-259** - Add task list filters for Status and Priority<br>*#tui #filters #ui* | | **TASK-282** - Fix TUI detail pane loading state regression [@codex]<br>*#bug* |
|
|
443
|
+
| **TASK-257** - Deep link URLs for tasks in board and list views | | **TASK-262** - TUI: Show all configured status columns in Kanban [@codex]<br>*#tui #board #kanban #config #parity* |
|
|
444
|
+
| **TASK-200** - Add Claude Code integration with workflow commands during init<br>*#enhancement #developer-experience* | | **TASK-281** - Fix backlog init skip option [@codex]<br>*#bug* |
|
|
445
|
+
| **TASK-244** - TUI: add live updates via watch in task list and kanban [@codex]<br>*#tui #watcher #enhancement* | | **TASK-279** - Add cleanup functionality to web UI for managing completed tasks [@claude] |
|
|
446
|
+
| **TASK-218** - Update documentation and tests for sequences<br>*#sequences #documentation #testing* | | **TASK-274** - Fix Kanban boards missing live updates [@claude] |
|
|
447
|
+
| **TASK-217** - Create web UI for sequences with drag-and-drop<br>*#sequences #web-ui #frontend* | | ββ **TASK-273.06** - 273.06: Web UI on centralized search [@codex]<br>*#web #search #ui* |
|
|
448
|
+
| ββ **TASK-217.03** - Sequences web UI: move tasks and update dependencies<br>*#sequences* | | ββ **TASK-273.05** - 273.05: Server endpoints on shared store/search [@codex]<br>*#server #search #infra* |
|
|
449
|
+
| ββ **TASK-217.04** - Sequences web UI: tests<br>*#sequences* | | ββ **TASK-273.04** - 273.04: CLI & TUI search integration [@codex]<br>*#cli #tui #search* |
|
|
450
|
+
| ββ **TASK-217.02** - Sequences web UI: list sequences<br>*#sequences* | | |
|
|
451
|
+
| **TASK-243** - Enable TUI task reordering with Shift+Arrow keys [@codex]<br>*#tui #ui #enhancement* | | |
|
|
452
|
+
| **TASK-240** - Improve binary resolution on Apple Silicon (Rosetta/arch mismatch) [@codex]<br>*#packaging #bug #macos* | | |
|
|
453
|
+
| **TASK-239** - Feature: Auto-link tasks to documents/decisions + backlinks [@codex]<br>*#web #enhancement #docs* | | |
|
|
454
|
+
| **TASK-222** - Improve task and subtask visualization in web UI | | |
|
|
455
|
+
| **TASK-208** - Add paste-as-markdown support in Web UI<br>*#web-ui #enhancement #markdown* | | |
|
|
382
456
|
|
|
383
457
|
<!-- BOARD_END -->
|
|
384
458
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "backlog.md",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.16.1",
|
|
4
4
|
"files": [
|
|
5
5
|
"cli.js",
|
|
6
6
|
"resolveBinary.cjs",
|
|
@@ -13,11 +13,11 @@
|
|
|
13
13
|
"backlog": "cli.js"
|
|
14
14
|
},
|
|
15
15
|
"optionalDependencies": {
|
|
16
|
-
"backlog.md-linux-x64": "1.
|
|
17
|
-
"backlog.md-linux-arm64": "1.
|
|
18
|
-
"backlog.md-darwin-x64": "1.
|
|
19
|
-
"backlog.md-darwin-arm64": "1.
|
|
20
|
-
"backlog.md-windows-x64": "1.
|
|
16
|
+
"backlog.md-linux-x64": "1.16.1",
|
|
17
|
+
"backlog.md-linux-arm64": "1.16.1",
|
|
18
|
+
"backlog.md-darwin-x64": "1.16.1",
|
|
19
|
+
"backlog.md-darwin-arm64": "1.16.1",
|
|
20
|
+
"backlog.md-windows-x64": "1.16.1"
|
|
21
21
|
},
|
|
22
22
|
"scripts": {
|
|
23
23
|
"postuninstall": "node postuninstall.cjs"
|