backlog.md-darwin-arm64 1.0.1 → 1.0.3
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 +149 -0
- package/backlog +0 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,149 @@
|
|
|
1
|
+
<h1 align="center">Backlog.md</h1>
|
|
2
|
+
<p align="center">Markdown‑native Task Manager & Kanban visualizer for any Git repository</p>
|
|
3
|
+
|
|
4
|
+
<p align="center">
|
|
5
|
+
<code>npm i -g backlog.md</code> or <code>bun add -g backlog.md</code>
|
|
6
|
+
</p>
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
> **Backlog.md** turns any folder with a Git repo into a **self‑contained project board**
|
|
14
|
+
> powered by plain Markdown files and a zero‑config CLI.
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
## Features
|
|
18
|
+
|
|
19
|
+
* 📝 **Markdown-native tasks** -- manage every issue as a plain `.md` file
|
|
20
|
+
|
|
21
|
+
* 🔒 **100 % private & offline** -- backlog lives entirely inside your repo
|
|
22
|
+
|
|
23
|
+
* 📊 **Instant terminal Kanban** -- `backlog board` paints a live board in your shell
|
|
24
|
+
|
|
25
|
+
* 🌐 **Modern web interface** -- `backlog browser` launches a sleek web UI for visual task management
|
|
26
|
+
|
|
27
|
+
* 🤖 **AI-ready CLI** -- "Claude, please take over task 33"
|
|
28
|
+
|
|
29
|
+
* 🔍 **Rich query commands** -- view, list, filter, or archive tasks with ease
|
|
30
|
+
|
|
31
|
+
* 💻 **Cross-platform** -- runs on macOS, Linux, and Windows
|
|
32
|
+
|
|
33
|
+
* 🆓 **MIT-licensed & open-source** -- free for personal or commercial use
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
### Five‑minute tour
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
# Make sure you have Backlog.md installed
|
|
41
|
+
bun/npm i -g backlog.md
|
|
42
|
+
|
|
43
|
+
# 1. Bootstrap a repo + backlog
|
|
44
|
+
backlog init hello-
|
|
45
|
+
|
|
46
|
+
# 2. Capture work
|
|
47
|
+
backlog task create "Render markdown as kanban"
|
|
48
|
+
|
|
49
|
+
# 3. See where you stand
|
|
50
|
+
backlog board view
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
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`).
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
### Web Interface
|
|
58
|
+
|
|
59
|
+
Launch a modern, responsive web interface for visual task management:
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
# Start the web server (opens browser automatically)
|
|
63
|
+
backlog browser
|
|
64
|
+
|
|
65
|
+
# Custom port
|
|
66
|
+
backlog browser --port 8080
|
|
67
|
+
|
|
68
|
+
# Don't open browser automatically
|
|
69
|
+
backlog browser --no-open
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
The web interface provides:
|
|
75
|
+
- **Interactive Kanban board** with drag-and-drop functionality
|
|
76
|
+
- **Task creation and editing** with rich forms and validation
|
|
77
|
+
- **Real-time updates** as you manage tasks
|
|
78
|
+
- **Responsive design** that works on desktop and mobile
|
|
79
|
+
- **Archive tasks** with confirmation dialogs
|
|
80
|
+
- **Seamless CLI integration** - changes sync with your markdown files
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
|
|
84
|
+
## CLI reference (essentials)
|
|
85
|
+
|
|
86
|
+
| Action | Example |
|
|
87
|
+
|-------------|------------------------------------------------------|
|
|
88
|
+
| Create task | `backlog task create "Add OAuth System"` |
|
|
89
|
+
| Create with description | `backlog task create "Feature" -d "Add authentication system"` |
|
|
90
|
+
| Create with assignee | `backlog task create "Feature" -a @sara` |
|
|
91
|
+
| Create with status | `backlog task create "Feature" -s "In Progress"` |
|
|
92
|
+
| Create with labels | `backlog task create "Feature" -l auth,backend` |
|
|
93
|
+
| Create with priority | `backlog task create "Feature" --priority high` |
|
|
94
|
+
| Create with plan | `backlog task create "Feature" --plan "1. Research\n2. Implement"` |
|
|
95
|
+
| Create with AC | `backlog task create "Feature" --ac "Must work,Must be tested"` |
|
|
96
|
+
| Create with deps | `backlog task create "Feature" --dep task-1,task-2` |
|
|
97
|
+
| Create sub task | `backlog task create -p 14 "Add Login with Google"`|
|
|
98
|
+
| Create draft | `backlog task create "Feature" --draft` |
|
|
99
|
+
| Create (all options) | `backlog task create "Feature" -d "Description" -a @sara -s "To Do" -l auth --priority high --ac "Must work" --dep task-1 -p 14` |
|
|
100
|
+
| List tasks | `backlog task list [-s <status>] [-a <assignee>]` |
|
|
101
|
+
| View detail | `backlog task 7` (interactive UI, press 'E' to edit in editor) |
|
|
102
|
+
| View (AI mode) | `backlog task 7 --plain` |
|
|
103
|
+
| Edit | `backlog task edit 7 -a @sara -l auth,backend` |
|
|
104
|
+
| Add plan | `backlog task edit 7 --plan "Implementation approach"` |
|
|
105
|
+
| Add AC | `backlog task edit 7 --ac "New criterion,Another one"` |
|
|
106
|
+
| Add deps | `backlog task edit 7 --dep task-1 --dep task-2` |
|
|
107
|
+
| Archive | `backlog task archive 7` |
|
|
108
|
+
| Draft flow | `backlog draft create "Spike GraphQL"` → `backlog draft promote 3.1` |
|
|
109
|
+
| Demote to draft| `backlog task demote <id>` |
|
|
110
|
+
| Kanban board | `backlog board` (interactive UI, press 'E' to edit in editor) |
|
|
111
|
+
| Web interface | `backlog browser` (launches web UI on port 6420) |
|
|
112
|
+
| Web custom port | `backlog browser --port 8080 --no-open` |
|
|
113
|
+
| Config editor | `backlog config set defaultEditor "code --wait"` |
|
|
114
|
+
| View config | `backlog config list` |
|
|
115
|
+
|
|
116
|
+
Full help: `backlog --help`
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
|
|
120
|
+
## Configuration
|
|
121
|
+
|
|
122
|
+
Backlog.md merges the following layers (highest → lowest):
|
|
123
|
+
|
|
124
|
+
1. CLI flags
|
|
125
|
+
2. `backlog/config.yml` (per‑project)
|
|
126
|
+
3. `~/backlog/user` (per‑user)
|
|
127
|
+
4. Built‑ins
|
|
128
|
+
|
|
129
|
+
Key options:
|
|
130
|
+
|
|
131
|
+
| Key | Purpose | Default |
|
|
132
|
+
|-------------------|--------------------|-------------------------------|
|
|
133
|
+
| `default_assignee`| Pre‑fill assignee | `[]` |
|
|
134
|
+
| `default_status` | First column | `To Do` |
|
|
135
|
+
| `statuses` | Board columns | `[To Do, In Progress, Done]` |
|
|
136
|
+
| `date_format` | ISO or locale | `yyyy-mm-dd` |
|
|
137
|
+
| `default_editor` | Editor for 'E' key | Platform default (nano/notepad) |
|
|
138
|
+
| `default_port` | Web UI port | `6420` |
|
|
139
|
+
| `auto_open_browser`| Open browser automatically | `true` |
|
|
140
|
+
| `remote_operations`| Enable remote git operations | `true` |
|
|
141
|
+
|
|
142
|
+
> **Note**: Set `remote_operations: false` to work offline. This disables git fetch operations and loads tasks from local branches only, useful when working without network connectivity.
|
|
143
|
+
|
|
144
|
+
---
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
## License
|
|
148
|
+
|
|
149
|
+
Backlog.md is released under the **MIT License** – do anything, just give credit. See [LICENSE](LICENSE).
|
package/backlog
CHANGED
|
Binary file
|