Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (backlog.md) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Backlog.md
✏️ Markdown‑native Task Manager & Kanban visualizer for any Git repository
Backlog.md turns any folder with a Git repo into a self‑contained project board
powered by plain Markdown files and a zero‑config CLI.
- 100 % offline‑friendly – your backlog lives inside your repository
- Works on macOS, Linux and Windows (Node ≥ 18 / Bun ≥ 1.0)
- Completely free & open‑source (MIT)
Quick install
# global – Node
npm i -g backlog.md
# global – Bun
bun add -g backlog.md # Bun 1.0+Prefer per‑project installs?
npm i -D backlog.md→npx backlog …
Five‑minute tour
# 1. Bootstrap a repo + backlog
backlog init hello-world
# 2. Capture work
backlog task create "Render markdown as kanban"
# 3. See where you stand
backlog board viewAll data is saved under .backlog folder as human‑readable Markdown (task‑12 - Fix typo.md).
CLI reference (essentials)
| Action | Example |
|---|---|
| Create task | backlog task create "Add OAuth" |
| Create sub task | backlog task create --parent 14 "Add Google auth" |
| List tasks | backlog task list [-s <status>] [-a <assignee> |
| View detail | backlog task 7 |
| Edit | backlog task edit 7 -a @sara -l auth,backend |
| Archive | backlog task archive 7 |
| Draft flow | backlog draft create "Spike GraphQL" → backlog draft promote 3.1 |
| Demote to draft | backlog task demote <id> |
| Kanban | backlog board view |
Full help: backlog --help
Configuration
Backlog.md merges the following layers (highest → lowest):
- CLI flags
.backlog/config.yml(per‑project)~/.backlog/user(per‑user)- Built‑ins
Key options:
| Key | Purpose | Default |
|---|---|---|
default_assignee |
Pre‑fill assignee | [] |
default_status |
First column | To Do |
statuses |
Board columns | [To Do, In Progress, Done] |
date_format |
ISO or locale | yyyy-mm-dd |
License
Backlog.md is released under the MIT License – do anything, just give credit. See LICENSE.