backlog.md-darwin-arm64 1.46.0 → 1.47.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 +11 -11
- package/backlog +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -56,8 +56,8 @@ backlog init "Personal Planning" --no-git
|
|
|
56
56
|
```
|
|
57
57
|
|
|
58
58
|
The init wizard will ask how you want to connect AI tools:
|
|
59
|
-
- **
|
|
60
|
-
- **
|
|
59
|
+
- **CLI instructions** (recommended) — creates a short instruction file that tells agents to run `backlog instructions overview`.
|
|
60
|
+
- **MCP connector** — optionally auto-configures Claude Code, Codex, Gemini CLI, Kiro or Cursor for teams that prefer MCP.
|
|
61
61
|
- **Skip** — no AI setup; use Backlog.md purely as a task manager.
|
|
62
62
|
|
|
63
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.
|
|
@@ -67,7 +67,7 @@ Backlog data is stored in a project-local backlog folder such as `backlog/`, `.b
|
|
|
67
67
|
### Working with AI agents
|
|
68
68
|
|
|
69
69
|
This is the recommended flow for Claude Code, Codex, Gemini CLI, Kiro and similar tools — following the **spec‑driven AI development** approach.
|
|
70
|
-
After running `backlog init
|
|
70
|
+
After running `backlog init`, agents should start by running `backlog instructions overview`. Work in this loop:
|
|
71
71
|
|
|
72
72
|
**Step 1 — Describe your idea.** Tell the agent what you want to build and ask it to split the work into small tasks with clear descriptions and acceptance criteria.
|
|
73
73
|
|
|
@@ -115,7 +115,7 @@ backlog board
|
|
|
115
115
|
backlog browser
|
|
116
116
|
```
|
|
117
117
|
|
|
118
|
-
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`. Use task comments for discussion and review notes; comment bodies may contain Markdown, but standalone `---` lines are reserved as comment delimiters. Use Implementation Notes for execution progress and Final Summary for
|
|
118
|
+
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`. Use task comments for discussion and review notes; comment bodies may contain Markdown, but standalone `---` lines are reserved as comment delimiters. Use Implementation Notes for execution progress and Final Summary for completion notes.
|
|
119
119
|
|
|
120
120
|
**Learn more:** [CLI reference](CLI-INSTRUCTIONS.md) | [Advanced configuration](ADVANCED-CONFIG.md)
|
|
121
121
|
|
|
@@ -153,8 +153,8 @@ To keep the Web UI running as an auto-starting local service, see [Running Backl
|
|
|
153
153
|
|
|
154
154
|
## 🔧 MCP Integration (Model Context Protocol)
|
|
155
155
|
|
|
156
|
-
|
|
157
|
-
You can run `backlog init` (even if you already initialized Backlog.md)
|
|
156
|
+
CLI instructions are the default AI setup. MCP remains supported for AI coding assistants like Claude Code, Codex, Gemini CLI and Kiro when you explicitly prefer an MCP connector.
|
|
157
|
+
You can run `backlog init` (even if you already initialized Backlog.md) and choose MCP integration, or follow the manual steps below.
|
|
158
158
|
|
|
159
159
|
### Client guides
|
|
160
160
|
|
|
@@ -171,7 +171,7 @@ You can run `backlog init` (even if you already initialized Backlog.md) to set u
|
|
|
171
171
|
<summary><strong>Codex</strong></summary>
|
|
172
172
|
|
|
173
173
|
```bash
|
|
174
|
-
codex mcp add backlog backlog mcp start
|
|
174
|
+
codex mcp add backlog -- backlog mcp start
|
|
175
175
|
```
|
|
176
176
|
|
|
177
177
|
</details>
|
|
@@ -216,12 +216,12 @@ If your IDE can't set the process working directory for MCP servers, set `BACKLO
|
|
|
216
216
|
If your IDE supports custom args but not env vars, you can also use `["mcp", "start", "--cwd", "/absolute/path/to/your/project"]`.
|
|
217
217
|
|
|
218
218
|
> [!IMPORTANT]
|
|
219
|
-
> When adding the MCP server manually,
|
|
219
|
+
> When adding the MCP server manually, add a short instruction to your CLAUDE.md/AGENTS.md files telling agents to read `backlog://workflow/overview`.
|
|
220
220
|
> This step is not required when using `backlog init` as it adds these instructions automatically.
|
|
221
|
-
>
|
|
221
|
+
> For CLI-based setups, use `backlog instructions overview` to fetch the current workflow guidance.
|
|
222
222
|
|
|
223
223
|
|
|
224
|
-
Once connected, agents can read the Backlog.md workflow instructions via
|
|
224
|
+
Once connected, agents can read the Backlog.md workflow instructions via `backlog://workflow/overview`, with detailed guides at `backlog://workflow/task-creation`, `backlog://workflow/task-execution`, and `backlog://workflow/task-finalization`.
|
|
225
225
|
Use `/mcp` command in your AI tool (Claude Code, Codex, Kiro) to verify if the connection is working.
|
|
226
226
|
|
|
227
227
|
---
|
|
@@ -230,7 +230,7 @@ Use `/mcp` command in your AI tool (Claude Code, Codex, Kiro) to verify if the c
|
|
|
230
230
|
|
|
231
231
|
Full command reference — task management, search, board, docs, decisions, and more: **[CLI-INSTRUCTIONS.md](CLI-INSTRUCTIONS.md)**
|
|
232
232
|
|
|
233
|
-
Quick examples: `backlog task create`, `backlog task list`, `backlog task edit`, `backlog search`, `backlog board`, `backlog browser`.
|
|
233
|
+
Quick examples: `backlog`, `backlog instructions`, `backlog task create`, `backlog task list`, `backlog task edit`, `backlog milestone add`, `backlog milestone rename`, `backlog milestone remove`, `backlog search`, `backlog board`, `backlog browser`.
|
|
234
234
|
|
|
235
235
|
Full help: `backlog --help`
|
|
236
236
|
|
package/backlog
CHANGED
|
Binary file
|