backlog.md 1.5.5 → 1.5.7

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.
Files changed (2) hide show
  1. package/README.md +34 -25
  2. package/package.json +6 -6
package/README.md CHANGED
@@ -36,34 +36,39 @@
36
36
 
37
37
  ---
38
38
 
39
- ### Five‑minute tour
40
-
41
- ```markdown
42
- # Make sure you have Backlog.md installed
43
- bun/npm i -g backlog.md
39
+ ## <img src="./.github/5-minute-tour-256.png" alt="5-minute tour" width="28" height="28" align="center"> Five‑minute tour
40
+ ```bash
41
+ # 1. Make sure you have Backlog.md installed
42
+ bun/npm i -g backlog.md or brew install backlog-md
44
43
 
45
- # 1. Bootstrap a repo + backlog
46
- backlog init hello-
44
+ # 2. Bootstrap a repo + backlog
45
+ backlog init "My Awesome Project"
47
46
 
48
- # 2. Capture work
47
+ # 3. Capture work
49
48
  backlog task create "Render markdown as kanban"
50
49
 
51
- # 3. See where you stand
52
- backlog board view
50
+ # 4. See where you stand
51
+ backlog board view or backlog browser
53
52
 
54
- # 4. Working with AI
53
+ # 5. Create tasks using Claude-code, Gemini, Codex or Jules
55
54
  Claude I would like to build a search functionality in the web view that searches for:
56
55
  * tasks
57
56
  * docs
58
57
  * decisions
59
- Please create relevant tasks to tackle this request.
58
+ Please create relevant tasks to tackle this request.
59
+
60
+ # 6. Assign tasks to AI
61
+ Claude please implement all tasks related to the web search functionality (task-10, task-11, task-12)
62
+ * before starting to write code use 'ultrathink mode' to prepare an implementation plan
63
+ * use multiple sub-agents when possible and dependencies allow
60
64
  ```
61
65
 
62
- All data is saved under `backlog` folder as human‑readable Markdown with the following format `task-<task-id> - <task-title>.md` (e.g. `task-12 - Fix typo.md`).
66
+
67
+ 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`).
63
68
 
64
69
  ---
65
70
 
66
- ### Web Interface
71
+ ## <img src="./.github/web-interface-256.png" alt="Web Interface" width="28" height="28" align="center"> Web Interface
67
72
 
68
73
  Launch a modern, responsive web interface for visual task management:
69
74
 
@@ -90,7 +95,7 @@ The web interface provides:
90
95
 
91
96
  ---
92
97
 
93
- ## CLI reference
98
+ ## <img src="./.github/cli-reference-256.png" alt="CLI Reference" width="28" height="28" align="center"> CLI reference
94
99
 
95
100
  ### Project Setup
96
101
 
@@ -105,6 +110,8 @@ The `backlog init` command provides comprehensive project setup with interactive
105
110
  - **Default editor** - editor command for opening tasks (detects from environment)
106
111
  - **Remote operations** - enable/disable fetching tasks from remote branches
107
112
  - **Web UI settings** - port and browser auto-open preferences
113
+ - **Agent guidelines** - AI agent instruction files (CLAUDE.md, .cursorrules, etc.)
114
+ - **Claude Code agent** - optional Backlog.md agent for enhanced task management
108
115
 
109
116
  When re-initializing an existing project, all current configuration values are preserved and pre-populated in prompts, allowing you to update only what you need.
110
117
 
@@ -199,14 +206,14 @@ Full help: `backlog --help`
199
206
 
200
207
  ---
201
208
 
202
- ## Configuration
209
+ ## <img src="./.github/configuration-256.png" alt="Configuration" width="28" height="28" align="center"> Configuration
203
210
 
204
211
  Backlog.md merges the following layers (highest → lowest):
205
212
 
206
- 1. CLI flags
207
- 2. `backlog/config.yml` (per‑project)
208
- 3. `~/backlog/user` (per‑user)
209
- 4. Built‑ins
213
+ 1. CLI flags
214
+ 2. `backlog/config.yml` (per‑project)
215
+ 3. `~/backlog/user` (per‑user)
216
+ 4. Built‑ins
210
217
 
211
218
  Key options:
212
219
 
@@ -229,7 +236,7 @@ Key options:
229
236
 
230
237
  ---
231
238
 
232
- ## Sharing & Export
239
+ ## <img src="./.github/sharing-export-256.png" alt="Sharing & Export" width="28" height="28" align="center"> Sharing & Export
233
240
 
234
241
  ### Board Export
235
242
 
@@ -259,15 +266,17 @@ Perfect for sharing project status, creating reports, or storing snapshots in ve
259
266
 
260
267
  <!-- BOARD_START -->
261
268
 
262
- ## 📊 Backlog.md Project Status (v0.0.0)
269
+ ## 📊 Backlog.md Project Status (v1.5.6)
263
270
 
264
271
  This board was automatically generated by [Backlog.md](https://backlog.md)
265
272
 
266
- Generated on: 2025-07-22 21:05:56
273
+ Generated on: 2025-07-23 21:54:54
267
274
 
268
275
  | To Do | In Progress | Done |
269
276
  | --- | --- | --- |
270
- | **task-183** - Add ordinal field for custom task ordering in web UI<br>(Assignees: none, Labels: none) | **└─ task-24.1** - CLI: Kanban board milestone view<br>(Assignees: @codex, Labels: none) | **task-198** - Fix markdown content overflow beyond screen width<br>(Assignees: none, Labels: none) |
277
+ | **task-201** - Add configurable git hooks bypass option<br>(Assignees: none, Labels: enhancement, git) | **└─ task-24.1** - CLI: Kanban board milestone view<br>(Assignees: @codex, Labels: none) | **task-202** - Fix editor integration regression with Helix and other interactive editors<br>(Assignees: none, Labels: bug, regression, editor) |
278
+ | **task-200** - Add Claude Code integration with workflow commands during init<br>(Assignees: none, Labels: enhancement, developer-experience) | | **task-199** - Add version parameter to board export command<br>(Assignees: none, Labels: none) |
279
+ | **task-183** - Add ordinal field for custom task ordering in web UI<br>(Assignees: none, Labels: none) | | **task-198** - Fix markdown content overflow beyond screen width<br>(Assignees: none, Labels: none) |
271
280
  | **task-181** - Add statistics dashboard to web UI<br>(Assignees: none, Labels: none) | | **task-197** - Fix decision page refresh showing blank screen<br>(Assignees: none, Labels: none) |
272
281
  | **task-180** - Add statistics overview command to CLI with TUI interface<br>(Assignees: none, Labels: none) | | **task-196** - Add NixOS packaging support<br>(Assignees: none, Labels: none) |
273
282
  | **task-175** - Add hour and minute to all dates in drafts, tasks, documents, decisions<br>(Assignees: none, Labels: none) | | **task-195** - Fix React Router deep linking for documentation and decisions pages<br>(Assignees: @claude, Labels: bug, routing, react, ux) |
@@ -280,6 +289,6 @@ Generated on: 2025-07-22 21:05:56
280
289
 
281
290
  <!-- BOARD_END -->
282
291
 
283
- ## License
292
+ ### License
284
293
 
285
294
  Backlog.md is released under the **MIT License** – do anything, just give credit. See [LICENSE](LICENSE).
package/package.json CHANGED
@@ -1,15 +1,15 @@
1
1
  {
2
2
  "name": "backlog.md",
3
- "version": "1.5.5",
3
+ "version": "1.5.7",
4
4
  "bin": {
5
5
  "backlog": "cli.js"
6
6
  },
7
7
  "optionalDependencies": {
8
- "backlog.md-linux-x64": "1.5.5",
9
- "backlog.md-linux-arm64": "1.5.5",
10
- "backlog.md-darwin-x64": "1.5.5",
11
- "backlog.md-darwin-arm64": "1.5.5",
12
- "backlog.md-windows-x64": "1.5.5"
8
+ "backlog.md-linux-x64": "1.5.7",
9
+ "backlog.md-linux-arm64": "1.5.7",
10
+ "backlog.md-darwin-x64": "1.5.7",
11
+ "backlog.md-darwin-arm64": "1.5.7",
12
+ "backlog.md-windows-x64": "1.5.7"
13
13
  },
14
14
  "scripts": {
15
15
  "postuninstall": "node postuninstall.cjs"