backlog.md-darwin-x64 1.52.0 β 1.54.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 +52 -6
- package/backlog +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -90,9 +90,7 @@ backlog init "Personal Planning" --no-git
|
|
|
90
90
|
```
|
|
91
91
|
|
|
92
92
|
> [!TIP]
|
|
93
|
-
> **
|
|
94
|
-
> Without an install, `npx backlog` resolves to an unrelated third-party npm package β not this tool.
|
|
95
|
-
> (With `backlog.md` installed as a project dependency, `npx backlog` runs the local binary as usual.)
|
|
93
|
+
> **Trying it without installing?** Use the full package name: `npx backlog.md init "My Project"`, `npx backlog.md board`.
|
|
96
94
|
|
|
97
95
|
### Run with Nix
|
|
98
96
|
|
|
@@ -109,9 +107,11 @@ nix profile install github:MrLesk/Backlog.md#backlog-md
|
|
|
109
107
|
```
|
|
110
108
|
|
|
111
109
|
The Nix flake supports `x86_64-linux`, `aarch64-linux`, and
|
|
112
|
-
`aarch64-darwin`. The x86_64 Linux package uses
|
|
113
|
-
|
|
114
|
-
|
|
110
|
+
`aarch64-darwin`. The x86_64 Linux package uses
|
|
111
|
+
[Bun's unified x64 runtime](https://bun.com/docs/installation#cpu-requirements),
|
|
112
|
+
with an SSE4.2 minimum and automatic CPU-specific paths. Pre-AVX2 compatibility
|
|
113
|
+
is checked under Ivy Bridge emulation. Intel macOS users can use the npm, Bun,
|
|
114
|
+
or Homebrew installation instead.
|
|
115
115
|
|
|
116
116
|
The init wizard will ask how you want to connect AI tools:
|
|
117
117
|
- **CLI instructions** (recommended): creates a short instruction file that tells agents to run `backlog instructions overview`.
|
|
@@ -122,6 +122,9 @@ For Cursor with CLI instructions, select AGENTS.md or pass `--agent-instructions
|
|
|
122
122
|
|
|
123
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. `backlog_directory: my-backlog`). 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.
|
|
124
124
|
|
|
125
|
+
> [!TIP]
|
|
126
|
+
> **Want an architecture diagram of your repo, kept up to date automatically?** See the [Backlog.md + Groma.md integration](#groma-md) below.
|
|
127
|
+
|
|
125
128
|
---
|
|
126
129
|
|
|
127
130
|
## Working with AI agents
|
|
@@ -152,6 +155,8 @@ After running `backlog init`, agents should start by running `backlog instructio
|
|
|
152
155
|
> [!NOTE]
|
|
153
156
|
> **Review checkpoint #3:** review the code, run tests, check linting, and verify the results match your expectations.
|
|
154
157
|
|
|
158
|
+
Mark verified work Done (or the configured final status). During periodic cleanup, `backlog task archive` moves it off the board; the same command takes canceled, duplicate, or invalid work off the board at any time. An archived task keeps its ID, record, and dependency links, stays readable with `backlog task view`, and is read-only. `backlog task restore` brings an archived task back to the board with the same ID. To remove a task for good, archive it and then run `backlog task delete`, which releases its ID once no other branch or worktree still holds the task.
|
|
159
|
+
|
|
155
160
|
If the output is not good enough: clear the plan/notes/final summary, refine the task description and acceptance criteria, and run the task again in a fresh session.
|
|
156
161
|
|
|
157
162
|
---
|
|
@@ -184,6 +189,47 @@ Read commands support stable, versioned JSON for scripts and integrations. Use `
|
|
|
184
189
|
|
|
185
190
|
---
|
|
186
191
|
|
|
192
|
+
<a id="groma-md"></a>
|
|
193
|
+
|
|
194
|
+
## πΊοΈ Backlog.md + Groma.md
|
|
195
|
+
|
|
196
|
+
Backlog.md keeps the spec, the plan and the code reviewable. [Groma.md](https://groma.md) adds the
|
|
197
|
+
architecture: it scans your repository into a C4 map that you or your coding agent curate, stored next
|
|
198
|
+
to your code as an [Open Knowledge Format 0.2](https://github.com/GoogleCloudPlatform/open-knowledge-format/blob/main/SPEC.md)
|
|
199
|
+
bundle. It reads your Backlog.md tasks, so the two work well together:
|
|
200
|
+
|
|
201
|
+
<picture>
|
|
202
|
+
<source media="(prefers-color-scheme: dark)" srcset="./.github/groma-map-dark.webp">
|
|
203
|
+
<img src="./.github/groma-map-light.webp" alt="Backlog.md's own architecture in Groma.md: Backlog.md tasks pinned to the components they touch, with one task selected and its acceptance criteria open" width="100%">
|
|
204
|
+
</picture>
|
|
205
|
+
|
|
206
|
+
* π **Tasks on the map** -- every task is pinned to the components it touches, so you see where the work lands in your system, not only in a list
|
|
207
|
+
|
|
208
|
+
* π **Who is doing what** -- with several agents at work, the map shows where each one is busy
|
|
209
|
+
|
|
210
|
+
* π **Review a task by its architecture** -- select a task to highlight the components it touches and inspect its changes without leaving the map
|
|
211
|
+
|
|
212
|
+
* π¦ **Open Knowledge Format 0.2** -- one Markdown document per element, so the map stays portable and readable without Groma.md
|
|
213
|
+
|
|
214
|
+
* π **Still plain files** -- both run locally, need no account, and keep everything as Markdown in your repo
|
|
215
|
+
|
|
216
|
+
Groma.md is a separate install, and Backlog.md works fine without it. To add the map to a repo that
|
|
217
|
+
already uses Backlog.md:
|
|
218
|
+
|
|
219
|
+
```bash
|
|
220
|
+
npm i -g groma.md
|
|
221
|
+
groma web
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
Backlog.md uses it on itself: every push to main updates its map, and every pull request gets a comment
|
|
225
|
+
showing what it changes in the architecture.
|
|
226
|
+
|
|
227
|
+
π **[Get started at groma.md](https://groma.md)**
|
|
228
|
+
|
|
229
|
+
πΊοΈ **[Explore Backlog.md's own architecture, live](https://mrlesk.github.io/Backlog.md/architecture/auto/)**
|
|
230
|
+
|
|
231
|
+
---
|
|
232
|
+
|
|
187
233
|
## <img src="./.github/web-interface-256.png" alt="Web Interface" width="28" height="28" align="center"> Web Interface
|
|
188
234
|
|
|
189
235
|
Launch a web interface for visual task management on the local machine. The server listens on `127.0.0.1` and is not
|
package/backlog
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
[diffend] Oversized file quarantined before diffing.
|
|
2
2
|
name: package/backlog
|
|
3
|
-
size:
|
|
4
|
-
sha256:
|
|
3
|
+
size: 95526384 bytes
|
|
4
|
+
sha256: a27388b12fbf746eb7cd9c49d2e11927644dd3f93f6b0b4bee359d87d620cc25
|