backlog.md-darwin-x64 1.55.3 → 1.57.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 +23 -1
- package/backlog +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -122,6 +122,8 @@ 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
|
+
Backlog.md reads record metadata as YAML between `---` lines at the top of each Markdown file. If an existing file declares a different header format, convert its metadata to YAML before opening it with Backlog.md.
|
|
126
|
+
|
|
125
127
|
> [!TIP]
|
|
126
128
|
> **Want an architecture diagram of your repo, kept up to date automatically?** See the [Backlog.md + Groma.md integration](#groma-md) below.
|
|
127
129
|
|
|
@@ -232,7 +234,7 @@ showing what it changes in the architecture.
|
|
|
232
234
|
|
|
233
235
|
## <img src="./.github/web-interface-256.png" alt="Web Interface" width="28" height="28" align="center"> Web Interface
|
|
234
236
|
|
|
235
|
-
Launch a web interface for visual task management on the local machine.
|
|
237
|
+
Launch a web interface for visual task management on the local machine. By default, the server listens on `127.0.0.1` and is not
|
|
236
238
|
reachable from other devices on the LAN or VPN:
|
|
237
239
|
|
|
238
240
|
```bash
|
|
@@ -260,6 +262,26 @@ backlog browser --no-open
|
|
|
260
262
|
|
|
261
263
|
To keep the Web UI running as an auto-starting local service, see [Running Backlog.md as a Service](backlog/docs/doc-003%20-%20Running-Backlog-Browser-as-a-Service.md).
|
|
262
264
|
|
|
265
|
+
### Publish a read-only snapshot
|
|
266
|
+
|
|
267
|
+
```bash
|
|
268
|
+
backlog browser export public/backlog
|
|
269
|
+
backlog browser export public/backlog --tasks --docs
|
|
270
|
+
backlog browser export public/backlog --tasks --decisions
|
|
271
|
+
backlog browser export public/backlog --decisions
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
Publish the generated directory with a static host such as GitHub Pages or GitLab Pages. With no flags, the export includes
|
|
275
|
+
tasks, documents, decisions, and milestones from the current checkout. Pass any combination of `--tasks`, `--docs`,
|
|
276
|
+
`--decisions`, and `--milestones` to publish only those sections. The board, task list, and statistics are part of
|
|
277
|
+
`--tasks`. Sections you leave out are absent from the saved data, sidebar, and search.
|
|
278
|
+
|
|
279
|
+
The export includes project assets linked from the published records. It skips drafts and archived records. When a
|
|
280
|
+
published task depends on an archived task, the export keeps that dependency’s ID and status.
|
|
281
|
+
|
|
282
|
+
Anyone with access to the site can read the published records, including task plans, notes, and comments.
|
|
283
|
+
Check the output before sharing it. To update the snapshot, run the command again and publish the new files.
|
|
284
|
+
|
|
263
285
|
---
|
|
264
286
|
|
|
265
287
|
## 🔧 MCP Integration (Model Context Protocol)
|
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: 115600864 bytes
|
|
4
|
+
sha256: 458dc47564ab412d66060c142453a6c79547831ad1ca76d1aabfc6b1566bee4d
|