backlog.md 1.2.6 → 1.2.8

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 +112 -4
  2. package/package.json +6 -6
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
  <p align="center">Markdown‑native Task Manager &amp; Kanban visualizer for any Git repository</p>
3
3
 
4
4
  <p align="center">
5
- <code>npm i -g backlog.md</code> or <code>bun add -g backlog.md</code>
5
+ <code>npm i -g backlog.md</code> or <code>bun add -g backlog.md</code> or <code>brew install backlog-md</code>
6
6
  </p>
7
7
 
8
8
  ![Backlog demo GIF using: backlog board](./.github/backlog.gif)
@@ -90,7 +90,25 @@ The web interface provides:
90
90
 
91
91
  ---
92
92
 
93
- ## CLI reference (essentials)
93
+ ## CLI reference
94
+
95
+ ### Project Setup
96
+
97
+ | Action | Example |
98
+ |-------------|------------------------------------------------------|
99
+ | Initialize project | `backlog init [project-name]` (creates backlog structure with interactive configuration) |
100
+ | Re-initialize | `backlog init` (preserves existing config, allows updates) |
101
+
102
+ The `backlog init` command provides comprehensive project setup with interactive prompts for:
103
+ - **Project name** - identifier for your backlog
104
+ - **Auto-commit** - whether to automatically commit task changes to git
105
+ - **Default editor** - editor command for opening tasks (detects from environment)
106
+ - **Remote operations** - enable/disable fetching tasks from remote branches
107
+ - **Web UI settings** - port and browser auto-open preferences
108
+
109
+ 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
+
111
+ ### Task Management
94
112
 
95
113
  | Action | Example |
96
114
  |-------------|------------------------------------------------------|
@@ -105,7 +123,6 @@ The web interface provides:
105
123
  | Create with notes | `backlog task create "Feature" --notes "Started initial research"` |
106
124
  | Create with deps | `backlog task create "Feature" --dep task-1,task-2` |
107
125
  | Create sub task | `backlog task create -p 14 "Add Login with Google"`|
108
- | Create draft | `backlog task create "Feature" --draft` |
109
126
  | Create (all options) | `backlog task create "Feature" -d "Description" -a @sara -s "To Do" -l auth --priority high --ac "Must work" --notes "Initial setup done" --dep task-1 -p 14` |
110
127
  | List tasks | `backlog task list [-s <status>] [-a <assignee>] [-p <parent>]` |
111
128
  | List by parent | `backlog task list --parent 42` or `backlog task list -p task-42` |
@@ -117,17 +134,66 @@ The web interface provides:
117
134
  | Add notes | `backlog task edit 7 --notes "Completed X, working on Y"` |
118
135
  | Add deps | `backlog task edit 7 --dep task-1 --dep task-2` |
119
136
  | Archive | `backlog task archive 7` |
137
+
138
+ ### Draft Workflow
139
+
140
+ | Action | Example |
141
+ |-------------|------------------------------------------------------|
142
+ | Create draft | `backlog task create "Feature" --draft` |
120
143
  | Draft flow | `backlog draft create "Spike GraphQL"` → `backlog draft promote 3.1` |
121
144
  | Demote to draft| `backlog task demote <id>` |
122
- | Cleanup done tasks | `backlog cleanup` (move old completed tasks to completed folder) |
145
+
146
+ ### Board Operations
147
+
148
+ | Action | Example |
149
+ |-------------|------------------------------------------------------|
123
150
  | Kanban board | `backlog board` (interactive UI, press 'E' to edit in editor) |
124
151
  | Export board | `backlog board export [file]` (exports Kanban board to markdown) |
152
+
153
+ ### Web Interface
154
+
155
+ | Action | Example |
156
+ |-------------|------------------------------------------------------|
125
157
  | Web interface | `backlog browser` (launches web UI on port 6420) |
126
158
  | Web custom port | `backlog browser --port 8080 --no-open` |
159
+
160
+ ### Configuration
161
+
162
+ | Action | Example |
163
+ |-------------|------------------------------------------------------|
127
164
  | Config editor | `backlog config set defaultEditor "code --wait"` |
128
165
  | Enable auto-commit | `backlog config set autoCommit true` |
129
166
  | View config | `backlog config list` |
130
167
 
168
+ ### Documentation
169
+
170
+ | Action | Example |
171
+ |-------------|------------------------------------------------------|
172
+ | Create doc | `backlog doc create "API Guidelines"` |
173
+ | Create with path | `backlog doc create "Setup Guide" -p guides/setup` |
174
+ | Create with type | `backlog doc create "Architecture" -t technical` |
175
+ | List docs | `backlog doc list` |
176
+ | View doc | `backlog doc view doc-1` |
177
+
178
+ ### Decisions
179
+
180
+ | Action | Example |
181
+ |-------------|------------------------------------------------------|
182
+ | Create decision | `backlog decision create "Use PostgreSQL for primary database"` |
183
+ | Create with status | `backlog decision create "Migrate to TypeScript" -s proposed` |
184
+
185
+ ### Agent Instructions
186
+
187
+ | Action | Example |
188
+ |-------------|------------------------------------------------------|
189
+ | Update agent files | `backlog agents --update-instructions` (updates .cursorrules, CLAUDE.md, AGENTS.md, GEMINI.md, .github/copilot-instructions.md) |
190
+
191
+ ### Maintenance
192
+
193
+ | Action | Example |
194
+ |-------------|------------------------------------------------------|
195
+ | Cleanup done tasks | `backlog cleanup` (move old completed tasks to completed folder) |
196
+
131
197
  Full help: `backlog --help`
132
198
 
133
199
  ---
@@ -182,6 +248,48 @@ Perfect for sharing project status, creating reports, or storing snapshots in ve
182
248
 
183
249
  ---
184
250
 
251
+ <!-- BOARD_START -->
252
+
253
+ ## 📊 Backlog.md Project Status (automatically generated by Backlog.md)
254
+
255
+ Generated on: 2025-07-13 17:44:14
256
+
257
+ | To Do | In Progress | Done |
258
+ | --- | --- | --- |
259
+ | **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-185** - Fix task listing incorrectly including README.md files<br>(Assignees: @claude, Labels: none) |
260
+ | **task-181** - Add statistics dashboard to web UI<br>(Assignees: none, Labels: none) | | **task-184** - Investigate Windows bug with task edit status command<br>(Assignees: @claude, Labels: none) |
261
+ | **task-180** - Add statistics overview command to CLI with TUI interface<br>(Assignees: none, Labels: none) | | **task-182** - Document agents command and reorganize README CLI reference tables<br>(Assignees: @claude, Labels: none) |
262
+ | **task-179** - Add Settings page to web UI with configuration management<br>(Assignees: none, Labels: none) | | **task-178** - Enhance backlog init with comprehensive configuration and re-initialization support<br>(Assignees: @claude, Labels: none) |
263
+ | **task-175** - Add hour and minute to all dates in drafts, tasks, documents, decisions<br>(Assignees: none, Labels: none) | | **task-177** - Automate Kanban board updates in README.md on release<br>(Assignees: @gemini, Labels: none) |
264
+ | **task-172** - Order tasks by status and ID in both web and CLI lists<br>(Assignees: none, Labels: none) | | **task-176** - Add Priority Filtering/Sorting to Task List. Especially with the --plain flag.<br>(Assignees: none, Labels: enhancement) |
265
+ | **task-171** - Implement drafts list functionality in CLI and web UI<br>(Assignees: none, Labels: none) | | **task-174** - Implement backlog cleanup command with completed folder management<br>(Assignees: none, Labels: none) |
266
+ | | | **task-173** - Add CLI command to export Kanban board to markdown<br>(Assignees: @claude, Labels: none) |
267
+ | | | **task-169** - Fix browser and board crashes<br>(Assignees: @claude, Labels: none) |
268
+ | | | **task-168** - Fix editor integration issues with vim/nano<br>(Assignees: @claude, Labels: none) |
269
+ | | | **task-167** - Add --notes option to task create command<br>(Assignees: @claude, Labels: none) |
270
+ | | | **task-166** - Audit and fix autoCommit behavior across all commands<br>(Assignees: none, Labels: bug, config) |
271
+ | | | **task-165** - Fix BUN_OPTIONS environment variable conflict<br>(Assignees: none, Labels: bug) |
272
+ | | | **task-164** - Add auto_commit config option with default false<br>(Assignees: none, Labels: enhancement, config) |
273
+ | | | **task-163** - Fix intermittent git failure in task edit<br>(Assignees: none, Labels: bug) |
274
+ | | | **task-120** - Add offline mode configuration for remote operations<br>(Assignees: none, Labels: enhancement, offline, config) |
275
+ | | | **task-119** - Add documentation and decisions pages to web UI<br>(Assignees: none, Labels: none) |
276
+ | | | **└─ task-119.1** - Fix comprehensive test suite for data model consistency<br>(Assignees: none, Labels: none) |
277
+ | | | **└─ task-119.2** - Core architecture improvements and ID generation enhancements<br>(Assignees: none, Labels: none) |
278
+ | | | **task-118** - Add side navigation menu to web UI<br>(Assignees: none, Labels: none) |
279
+ | | | **└─ task-118.1** - UI/UX improvements and responsive design enhancements<br>(Assignees: none, Labels: none) |
280
+ | | | **└─ task-118.2** - Implement health check API endpoint for web UI monitoring<br>(Assignees: none, Labels: none) |
281
+ | | | **└─ task-118.3** - Advanced search and navigation features beyond basic requirements<br>(Assignees: none, Labels: none) |
282
+ | | | **task-116** - Add dark mode toggle to web UI<br>(Assignees: @claude, Labels: none) |
283
+ | | | **task-115** - Add live health check system to web UI<br>(Assignees: none, Labels: none) |
284
+ | | | **task-114** - cli: filter task list by parent task<br>(Assignees: none, Labels: none) |
285
+ | | | **task-105** - Remove dot from .backlog folder name<br>(Assignees: none, Labels: none) |
286
+ | | | **task-101** - Show task file path in plain view<br>(Assignees: none, Labels: none) |
287
+ | | | **└─ task-100.3** - Implement API endpoints<br>(Assignees: none, Labels: none) |
288
+ | | | **└─ task-100.7** - Bundle web assets into executable<br>(Assignees: none, Labels: none) |
289
+ | | | **└─ task-100.8** - Add documentation and examples<br>(Assignees: none, Labels: none) |
290
+
291
+ <!-- BOARD_END -->
292
+
185
293
  ## License
186
294
 
187
295
  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.2.6",
3
+ "version": "1.2.8",
4
4
  "bin": {
5
5
  "backlog": "cli.js"
6
6
  },
7
7
  "optionalDependencies": {
8
- "backlog.md-linux-x64": "1.2.6",
9
- "backlog.md-linux-arm64": "1.2.6",
10
- "backlog.md-darwin-x64": "1.2.6",
11
- "backlog.md-darwin-arm64": "1.2.6",
12
- "backlog.md-windows-x64": "1.2.6"
8
+ "backlog.md-linux-x64": "1.2.8",
9
+ "backlog.md-linux-arm64": "1.2.8",
10
+ "backlog.md-darwin-x64": "1.2.8",
11
+ "backlog.md-darwin-arm64": "1.2.8",
12
+ "backlog.md-windows-x64": "1.2.8"
13
13
  },
14
14
  "scripts": {
15
15
  "postuninstall": "node postuninstall.cjs"