backlog.md-darwin-arm64 1.43.0 → 1.45.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 +16 -3
- package/backlog +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -48,8 +48,11 @@ bun i -g backlog.md
|
|
|
48
48
|
# or: npm i -g backlog.md
|
|
49
49
|
# or: brew install backlog-md
|
|
50
50
|
|
|
51
|
-
# Initialize in any
|
|
51
|
+
# Initialize in any Git repo
|
|
52
52
|
backlog init "My Awesome Project"
|
|
53
|
+
|
|
54
|
+
# Or initialize without Git for local/non-code projects
|
|
55
|
+
backlog init "Personal Planning" --no-git
|
|
53
56
|
```
|
|
54
57
|
|
|
55
58
|
The init wizard will ask how you want to connect AI tools:
|
|
@@ -57,7 +60,7 @@ The init wizard will ask how you want to connect AI tools:
|
|
|
57
60
|
- **CLI commands** — creates instruction files (CLAUDE.md, AGENTS.md, etc.) so agents use Backlog via CLI.
|
|
58
61
|
- **Skip** — no AI setup; use Backlog.md purely as a task manager.
|
|
59
62
|
|
|
60
|
-
Backlog data is stored in a project-local backlog folder such as `backlog/`, `.backlog/`, or a custom project-relative path configured through `backlog.config.yml`. Tasks remain human-readable Markdown files (e.g. `task-10 - Add core search functionality.md`).
|
|
63
|
+
Backlog data is stored in a project-local backlog folder such as `backlog/`, `.backlog/`, or a custom project-relative path configured through `backlog.config.yml`. Tasks remain human-readable Markdown files (e.g. `task-10 - Add core search functionality.md`). Git is optional: `backlog init --no-git` creates a filesystem-only project and disables cross-branch checks, remote operations, and auto-commit.
|
|
61
64
|
|
|
62
65
|
---
|
|
63
66
|
|
|
@@ -111,7 +114,7 @@ backlog board
|
|
|
111
114
|
backlog browser
|
|
112
115
|
```
|
|
113
116
|
|
|
114
|
-
You can switch between AI-assisted and manual workflows at any time — both operate on the same Markdown task files. It is recommended to modify tasks via Backlog.md commands (CLI/MCP/Web) rather than editing task files manually, so field types and metadata stay consistent.
|
|
117
|
+
You can switch between AI-assisted and manual workflows at any time — both operate on the same Markdown task files. It is recommended to modify tasks via Backlog.md commands (CLI/MCP/Web) rather than editing task files manually, so field types and metadata stay consistent. Tasks can record project-root-relative modified files and later be found with `backlog search --modified-file src/path.ts --plain`.
|
|
115
118
|
|
|
116
119
|
**Learn more:** [CLI reference](CLI-INSTRUCTIONS.md) | [Advanced configuration](ADVANCED-CONFIG.md)
|
|
117
120
|
|
|
@@ -143,6 +146,8 @@ backlog browser --no-open
|
|
|
143
146
|
|
|
144
147
|

|
|
145
148
|
|
|
149
|
+
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).
|
|
150
|
+
|
|
146
151
|
---
|
|
147
152
|
|
|
148
153
|
## 🔧 MCP Integration (Model Context Protocol)
|
|
@@ -257,6 +262,8 @@ Skipping the wizard (answering "No" during init) applies the safe defaults that
|
|
|
257
262
|
- `defaultEditor` unset (falls back to your environment).
|
|
258
263
|
- `defaultPort=6420`, `autoOpenBrowser=true`.
|
|
259
264
|
|
|
265
|
+
For filesystem-only projects, run `backlog init --no-git`. Backlog.md will not run `git init`, and the saved config forces `checkActiveBranches=false`, `remoteOperations=false`, and `autoCommit=false` so CLI, Web, and MCP local-file workflows do not depend on a Git repository.
|
|
266
|
+
|
|
260
267
|
Whenever you revisit `backlog init` or rerun `backlog config`, the wizard pre-populates prompts with your current values so you can adjust only what changed.
|
|
261
268
|
|
|
262
269
|
### Definition of Done defaults
|
|
@@ -278,6 +285,12 @@ For the full configuration reference (all options, commands, and detailed notes)
|
|
|
278
285
|
|
|
279
286
|
---
|
|
280
287
|
|
|
288
|
+
## 🌐 Community Tools
|
|
289
|
+
|
|
290
|
+
- **[vscode-backlog-md](https://marketplace.visualstudio.com/items?itemName=ysamlan.vscode-backlog-md)** - VS Code extension with issues panel, kanban view, and editing. ([ysamlan/vscode-backlog-md](https://github.com/ysamlan/vscode-backlog-md))
|
|
291
|
+
|
|
292
|
+
---
|
|
293
|
+
|
|
281
294
|
### License
|
|
282
295
|
|
|
283
296
|
Backlog.md is released under the **MIT License** – do anything, just give credit. See [LICENSE](LICENSE).
|
package/backlog
CHANGED
|
Binary file
|