backlog.md-darwin-arm64 1.48.0 → 1.49.0
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 +26 -1
- package/backlog +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -94,11 +94,32 @@ backlog init "Personal Planning" --no-git
|
|
|
94
94
|
> Without an install, `npx backlog` resolves to an unrelated third-party npm package — not this tool.
|
|
95
95
|
> (With `backlog.md` installed as a project dependency, `npx backlog` runs the local binary as usual.)
|
|
96
96
|
|
|
97
|
+
### Run with Nix
|
|
98
|
+
|
|
99
|
+
Run Backlog.md directly from the repository flake:
|
|
100
|
+
|
|
101
|
+
```bash
|
|
102
|
+
nix run github:MrLesk/Backlog.md -- --version
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
Or install the named package into your Nix profile:
|
|
106
|
+
|
|
107
|
+
```bash
|
|
108
|
+
nix profile install github:MrLesk/Backlog.md#backlog-md
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
The Nix flake supports `x86_64-linux`, `aarch64-linux`, and
|
|
112
|
+
`aarch64-darwin`. The x86_64 Linux package uses Bun's baseline runtime so it
|
|
113
|
+
also works on pre-AVX2 processors with AVX support. Intel macOS users can use
|
|
114
|
+
the npm, Bun, or Homebrew installation instead.
|
|
115
|
+
|
|
97
116
|
The init wizard will ask how you want to connect AI tools:
|
|
98
117
|
- **CLI instructions** (recommended): creates a short instruction file that tells agents to run `backlog instructions overview`.
|
|
99
118
|
- **MCP connector**: optionally auto-configures Claude Code, Codex, Gemini CLI, Kiro or Cursor for teams that prefer MCP.
|
|
100
119
|
- **Skip**: no AI setup; use Backlog.md purely as a task manager.
|
|
101
120
|
|
|
121
|
+
For Cursor with CLI instructions, select AGENTS.md or pass `--agent-instructions cursor`; both use the same AGENTS.md target. Backlog.md preserves existing AGENTS.md content and does not migrate or remove unrelated user-managed `.cursor/rules` files.
|
|
122
|
+
|
|
102
123
|
Everything is stored as human-readable Markdown in a project-local backlog folder such as `backlog/`, `.backlog/`, or a custom project-relative path configured through `backlog.config.yml` (e.g. `task-10 - Add core search functionality.md`). Task IDs use a configurable prefix (`backlog init --task-prefix`): the default produces `TASK-1`-style IDs, while this repository uses `back`, so examples below show `BACK-1`-style IDs. Git is optional: `backlog init --no-git` creates a filesystem-only project.
|
|
103
124
|
|
|
104
125
|
---
|
|
@@ -146,6 +167,7 @@ backlog task edit BACK-1 -d "Detailed context" --ac "Clear acceptance criteria"
|
|
|
146
167
|
|
|
147
168
|
# Track work
|
|
148
169
|
backlog task list -s "To Do"
|
|
170
|
+
backlog task list --json | jq '.tasks[] | .id'
|
|
149
171
|
backlog task edit BACK-1 --comment "Can we split the UI work into a separate PR?" --comment-author @sara
|
|
150
172
|
backlog search "kanban"
|
|
151
173
|
backlog board
|
|
@@ -156,13 +178,16 @@ backlog browser
|
|
|
156
178
|
|
|
157
179
|
You can switch between AI-assisted and manual workflows at any time; both operate on the same Markdown task files. Just prefer Backlog.md commands (CLI/MCP/Web) over hand-editing task files, so field types and metadata stay consistent.
|
|
158
180
|
|
|
181
|
+
Read commands support stable, versioned JSON for scripts and integrations. Use `--json` with `task list`, `task view`, the `task <id>` shorthand, and `search`. JSON mode is noninteractive and keeps successful stdout machine-readable.
|
|
182
|
+
|
|
159
183
|
**Learn more:** [CLI reference](CLI-INSTRUCTIONS.md) | [Advanced configuration](ADVANCED-CONFIG.md)
|
|
160
184
|
|
|
161
185
|
---
|
|
162
186
|
|
|
163
187
|
## <img src="./.github/web-interface-256.png" alt="Web Interface" width="28" height="28" align="center"> Web Interface
|
|
164
188
|
|
|
165
|
-
Launch a
|
|
189
|
+
Launch a web interface for visual task management on the local machine. The server listens on `127.0.0.1` and is not
|
|
190
|
+
reachable from other devices on the LAN or VPN:
|
|
166
191
|
|
|
167
192
|
```bash
|
|
168
193
|
# Start the web server (opens browser automatically)
|
package/backlog
CHANGED
|
Binary file
|