backlog.md 0.1.34 → 0.1.37
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/package.json +15 -8
- package/readme.md +93 -0
package/package.json
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "backlog.md",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.37",
|
|
4
4
|
"bin": {
|
|
5
5
|
"backlog": "cli.js"
|
|
6
6
|
},
|
|
7
7
|
"optionalDependencies": {
|
|
8
|
-
"backlog.md-linux-x64": "
|
|
9
|
-
"backlog.md-linux-arm64": "
|
|
10
|
-
"backlog.md-darwin-x64": "
|
|
11
|
-
"backlog.md-darwin-arm64": "
|
|
12
|
-
"backlog.md-windows-x64": "
|
|
8
|
+
"backlog.md-linux-x64": "*",
|
|
9
|
+
"backlog.md-linux-arm64": "*",
|
|
10
|
+
"backlog.md-darwin-x64": "*",
|
|
11
|
+
"backlog.md-darwin-arm64": "*",
|
|
12
|
+
"backlog.md-windows-x64": "*"
|
|
13
13
|
},
|
|
14
14
|
"scripts": {
|
|
15
15
|
"test": "bun test",
|
|
@@ -53,7 +53,14 @@
|
|
|
53
53
|
"cli.js",
|
|
54
54
|
"resolveBinary.cjs",
|
|
55
55
|
"package.json",
|
|
56
|
-
"
|
|
56
|
+
"readme.md",
|
|
57
57
|
"LICENSE"
|
|
58
|
-
]
|
|
58
|
+
],
|
|
59
|
+
"dependencies": {
|
|
60
|
+
"backlog.md-linux-x64": "0.1.37",
|
|
61
|
+
"backlog.md-linux-arm64": "0.1.37",
|
|
62
|
+
"backlog.md-darwin-x64": "0.1.37",
|
|
63
|
+
"backlog.md-darwin-arm64": "0.1.37",
|
|
64
|
+
"backlog.md-windows-x64": "0.1.37"
|
|
65
|
+
}
|
|
59
66
|
}
|
package/readme.md
ADDED
|
@@ -0,0 +1,93 @@
|
|
|
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
|
+
<a href="https://www.npmjs.com/package/backlog.md"><img src="https://badgen.net/npm/v/backlog.md?icon=npm&label=npm&color=blue"></a>
|
|
6
|
+
<a href="https://bun.sh"><img src="https://badgen.net/badge/bun/add%20backlog.md/black?icon=bun"></a>
|
|
7
|
+
<a href="LICENSE"><img src="https://badgen.net/github/license/MrLesk/backlog.md"></a>
|
|
8
|
+
</p>
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
> **Backlog.md** turns any folder with a Git repo into a **self‑contained project board**
|
|
13
|
+
> powered by plain Markdown files and a zero‑config CLI.
|
|
14
|
+
|
|
15
|
+
* 100 % offline‑friendly – your backlog lives *inside* your repository
|
|
16
|
+
* Works on **macOS, Linux and Windows** (Node ≥ 18 / Bun ≥ 1.0)
|
|
17
|
+
* Completely free & open‑source (MIT)
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
### Quick install
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
# global – Node
|
|
25
|
+
npm i -g backlog.md
|
|
26
|
+
|
|
27
|
+
# global – Bun
|
|
28
|
+
bun add -g backlog.md # Bun 1.0+
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
> Prefer per‑project installs? `npm i -D backlog.md` → `npx backlog …`
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
### Five‑minute tour
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
# 1. Bootstrap a repo + backlog
|
|
39
|
+
backlog init hello-world
|
|
40
|
+
|
|
41
|
+
# 2. Capture work
|
|
42
|
+
backlog task create "Render markdown as kanban"
|
|
43
|
+
|
|
44
|
+
# 3. See where you stand
|
|
45
|
+
backlog board view
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
All data is saved under `.backlog` folder as human‑readable Markdown (`task‑12 - Fix typo.md`).
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
## CLI reference (essentials)
|
|
53
|
+
|
|
54
|
+
| Action | Example |
|
|
55
|
+
|-------------|------------------------------------------------------|
|
|
56
|
+
| Create task | `backlog task create "Add OAuth"` |
|
|
57
|
+
| Create sub task | `backlog task create --parent 14 "Add Google auth"`|
|
|
58
|
+
| List tasks | `backlog task list [-s <status>] [-a <assignee>` |
|
|
59
|
+
| View detail | `backlog task 7` |
|
|
60
|
+
| Edit | `backlog task edit 7 -a @sara -l auth,backend` |
|
|
61
|
+
| Archive | `backlog task archive 7` |
|
|
62
|
+
| Draft flow | `backlog draft create "Spike GraphQL"` → `backlog draft promote 3.1` |
|
|
63
|
+
| Demote to draft| `backlog task demote <id>` |
|
|
64
|
+
| Kanban | `backlog board view` |
|
|
65
|
+
|
|
66
|
+
Full help: `backlog --help`
|
|
67
|
+
|
|
68
|
+
---
|
|
69
|
+
|
|
70
|
+
## Configuration
|
|
71
|
+
|
|
72
|
+
Backlog.md merges the following layers (highest → lowest):
|
|
73
|
+
|
|
74
|
+
1. CLI flags
|
|
75
|
+
2. `.backlog/config.yml` (per‑project)
|
|
76
|
+
3. `~/.backlog/user` (per‑user)
|
|
77
|
+
4. Built‑ins
|
|
78
|
+
|
|
79
|
+
Key options:
|
|
80
|
+
|
|
81
|
+
| Key | Purpose | Default |
|
|
82
|
+
|-------------------|--------------------|-------------------------------|
|
|
83
|
+
| `default_assignee`| Pre‑fill assignee | `[]` |
|
|
84
|
+
| `default_status` | First column | `To Do` |
|
|
85
|
+
| `statuses` | Board columns | `[To Do, In Progress, Done]` |
|
|
86
|
+
| `date_format` | ISO or locale | `yyyy-mm-dd` |
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
## License
|
|
92
|
+
|
|
93
|
+
Backlog.md is released under the **MIT License** – do anything, just give credit. See [LICENSE](LICENSE).
|