@ugudlado1/backlog-windows-x64 2.0.2 → 2.1.8

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.
Files changed (3) hide show
  1. package/README.md +54 -51
  2. package/backlog.exe +0 -0
  3. package/package.json +5 -2
package/README.md CHANGED
@@ -1,42 +1,40 @@
1
- <h1 align="center">Backlog.md</h1>
1
+ <h1 align="center">Backlog</h1>
2
2
  <p align="center">Markdown‑native Task Manager &amp; Kanban visualizer for any Git repository</p>
3
3
 
4
4
  <p align="center">
5
- <code>npm i -g backlog.md</code> or <code>bun add -g backlog.md</code> or <code>nix run github:ugudlado/Backlog.md</code>
5
+ <code>npm i -g @ugudlado1/backlog</code> or <code>bun add -g @ugudlado1/backlog</code> or <code>nix run github:ugudlado/backlog</code>
6
6
  </p>
7
7
 
8
8
  ![Backlog demo GIF using: backlog board](./.github/backlog-v1.40.gif)
9
9
 
10
-
11
10
  ---
12
11
 
13
- > **Backlog.md** turns any folder with a Git repo into a **self‑contained project board**
12
+ > **Backlog** turns any folder with a Git repo into a **self‑contained project board**
14
13
  > powered by plain Markdown files and a zero‑config CLI.
15
14
  > Built for **spec‑driven AI development** — structure your tasks so AI agents deliver predictable results.
16
15
 
17
16
  ## Features
18
17
 
19
- * 📝 **Markdown-native tasks** -- manage every issue as a plain `.md` file
20
-
21
- * 🤖 **AI-Ready** -- Works with Claude Code, Gemini CLI, Codex, Kiro & any other MCP or CLI compatible AI assistants
18
+ - 📝 **Markdown-native tasks** -- manage every issue as a plain `.md` file
22
19
 
23
- * 📊 **Instant terminal Kanban** -- `backlog board` paints a live board in your shell
20
+ - 🤖 **AI-Ready** -- Works with Claude Code, Gemini CLI, Codex, Kiro & any other MCP or CLI compatible AI assistants
24
21
 
25
- * 🌐 **Modern web interface** -- `backlog server` launches a sleek web UI for visual task management; `backlog service` runs it as a launchd service on macOS
22
+ - 📊 **Instant terminal Kanban** -- `backlog board` paints a live board in your shell
26
23
 
27
- * 🔍 **Powerful search** -- fuzzy search across tasks, docs & decisions with `backlog search`
24
+ - 🌐 **Modern web interface** -- `backlog server` launches a sleek web UI for visual task management; `backlog service` runs it as a launchd service on macOS
28
25
 
29
- * 📋 **Rich query commands** -- view, list, filter, or archive tasks with ease
30
- * ✅ **Definition of Done defaults** -- add a reusable checklist to every new task
26
+ - 🔍 **Powerful search** -- fuzzy search across tasks, docs & decisions with `backlog search`
31
27
 
32
- * 📤 **Board export** -- `backlog board export` creates shareable markdown reports
28
+ - 📋 **Rich query commands** -- view, list, filter, or archive tasks with ease
29
+ - ✅ **Definition of Done defaults** -- add a reusable checklist to every new task
33
30
 
34
- * 🔒 **100 % private & offline** -- backlog lives entirely inside your repo and you can manage everything locally
31
+ - 📤 **Board export** -- `backlog board export` creates shareable markdown reports
35
32
 
36
- * 💻 **Cross-platform** -- runs on macOS, Linux, and Windows
33
+ - 🔒 **100 % private & offline** -- backlog lives entirely inside your repo and you can manage everything locally
37
34
 
38
- * 🆓 **MIT-licensed & open-source** -- free for personal or commercial use
35
+ - 💻 **Cross-platform** -- runs on macOS, Linux, and Windows
39
36
 
37
+ - 🆓 **MIT-licensed & open-source** -- free for personal or commercial use
40
38
 
41
39
  ---
42
40
 
@@ -44,8 +42,8 @@
44
42
 
45
43
  ```bash
46
44
  # Install
47
- bun i -g backlog.md
48
- # or: npm i -g backlog.md
45
+ bun i -g @ugudlado1/backlog
46
+ # or: npm i -g @ugudlado1/backlog
49
47
 
50
48
  # Configure the global store once (where all projects live)
51
49
  mkdir -p ~/.config/backlog
@@ -56,9 +54,10 @@ backlog init "My Awesome Project"
56
54
  ```
57
55
 
58
56
  The init wizard will ask how you want to connect AI tools:
57
+
59
58
  - **MCP connector** (recommended) — auto-configures Claude Code, Codex, Gemini CLI, Kiro or Cursor and adds workflow instructions for your agents.
60
59
  - **CLI commands** — creates instruction files (CLAUDE.md, AGENTS.md, etc.) so agents use Backlog via CLI.
61
- - **Skip** — no AI setup; use Backlog.md purely as a task manager.
60
+ - **Skip** — no AI setup; use Backlog purely as a task manager.
62
61
 
63
62
  Every project is stored as a slot in the configured **global store** (`globalStore` in `~/.config/backlog/config.yml`) — one directory per project, keyed by name, not tied to any repo. Tasks remain human-readable Markdown files (e.g. `task-10 - Add core search functionality.md`). List and switch projects with `backlog project list` / `backlog project switch <name>`, or target one per command with `--project <name>`.
64
63
 
@@ -72,7 +71,8 @@ After running `backlog init` and choosing the MCP or CLI integration, work in th
72
71
  **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
72
 
74
73
  **🤖 Ask your AI Agent:**
75
- > I want to add a search feature to the web view that searches tasks, docs, and decisions. Please decompose this into small Backlog.md tasks.
74
+
75
+ > I want to add a search feature to the web view that searches tasks, docs, and decisions. Please decompose this into small Backlog tasks.
76
76
 
77
77
  > [!NOTE]
78
78
  > **Review checkpoint #1** — read the task descriptions and acceptance criteria.
@@ -82,6 +82,7 @@ After running `backlog init` and choosing the MCP or CLI integration, work in th
82
82
  **Step 3 — Plan before coding.** Ask the agent to research and write an implementation plan in the task. Do this right before implementation so the plan reflects the current state of the codebase.
83
83
 
84
84
  **🤖 Ask your AI Agent:**
85
+
85
86
  > Work on BACK-10 only. Research the codebase and write an implementation plan in the task. Wait for my approval before coding.
86
87
 
87
88
  > [!NOTE]
@@ -98,7 +99,7 @@ If the output is not good enough: clear the plan/notes/final summary, refine the
98
99
 
99
100
  ### Working without AI agents
100
101
 
101
- Use Backlog.md as a standalone task manager from the terminal or browser.
102
+ Use Backlog as a standalone task manager from the terminal or browser.
102
103
 
103
104
  ```bash
104
105
  # Create and refine tasks
@@ -114,7 +115,7 @@ backlog board
114
115
  backlog server --open
115
116
  ```
116
117
 
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`.
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 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`.
118
119
 
119
120
  **Learn more:** [CLI reference](CLI-INSTRUCTIONS.md) | [Advanced configuration](ADVANCED-CONFIG.md)
120
121
 
@@ -149,9 +150,10 @@ backlog service uninstall # stop and remove plist
149
150
 
150
151
  The service serves the current project (recorded in `~/.config/backlog/projects.yml`). Switch projects from the project switcher in the web UI; the selection survives restarts.
151
152
 
152
- Linux (systemd) and Windows (Task Scheduler / NSSM) recipes live in [Running Backlog.md as a Service](SERVICE.md).
153
+ Linux (systemd) and Windows (Task Scheduler / NSSM) recipes live in [Running Backlog as a Service](SERVICE.md).
153
154
 
154
155
  **Features:**
156
+
155
157
  - Interactive Kanban board with drag-and-drop
156
158
  - Task creation and editing with rich forms
157
159
  - Interactive acceptance criteria editor with checklists
@@ -160,50 +162,50 @@ Linux (systemd) and Windows (Task Scheduler / NSSM) recipes live in [Running Bac
160
162
  - Task archiving with confirmation dialogs
161
163
  - Seamless CLI integration - all changes sync with markdown files
162
164
 
163
- ![Web Interface Screenshot](./.github/web.jpeg)
165
+ ![Web Interface Screenshot](./.github/web.png)
164
166
 
165
167
  ---
166
168
 
167
169
  ## 🔧 MCP Integration (Model Context Protocol)
168
170
 
169
- The easiest way to connect Backlog.md to AI coding assistants like Claude Code, Codex, Gemini CLI and Kiro is via the MCP protocol.
170
- You can run `backlog init` (even if you already initialized Backlog.md) to set up MCP integration automatically, or follow the manual steps below.
171
+ The easiest way to connect Backlog to AI coding assistants like Claude Code, Codex, Gemini CLI and Kiro is via the MCP protocol.
172
+ You can run `backlog init` (even if you already initialized Backlog) to set up MCP integration automatically, or follow the manual steps below.
171
173
 
172
174
  ### Client guides
173
175
 
174
176
  <details>
175
177
  <summary><strong>Claude Code</strong></summary>
176
178
 
177
- ```bash
178
- claude mcp add backlog --scope user -- backlog mcp start
179
- ```
179
+ ```bash
180
+ claude mcp add backlog --scope user -- backlog mcp start
181
+ ```
180
182
 
181
183
  </details>
182
184
 
183
185
  <details>
184
186
  <summary><strong>Codex</strong></summary>
185
187
 
186
- ```bash
187
- codex mcp add backlog backlog mcp start
188
- ```
188
+ ```bash
189
+ codex mcp add backlog backlog mcp start
190
+ ```
189
191
 
190
192
  </details>
191
193
 
192
194
  <details>
193
195
  <summary><strong>Gemini CLI</strong></summary>
194
196
 
195
- ```bash
196
- gemini mcp add backlog -s user backlog mcp start
197
- ```
197
+ ```bash
198
+ gemini mcp add backlog -s user backlog mcp start
199
+ ```
198
200
 
199
201
  </details>
200
202
 
201
203
  <details>
202
204
  <summary><strong>Kiro</strong></summary>
203
205
 
204
- ```bash
205
- kiro-cli mcp add --scope global --name backlog --command backlog --args mcp,start
206
- ```
206
+ ```bash
207
+ kiro-cli mcp add --scope global --name backlog --command backlog --args mcp,start
208
+ ```
207
209
 
208
210
  </details>
209
211
 
@@ -229,12 +231,11 @@ If your IDE can't set the process working directory for MCP servers, set `BACKLO
229
231
  If your IDE supports custom args but not env vars, you can also use `["mcp", "start", "--cwd", "/absolute/path/to/your/project"]`.
230
232
 
231
233
  > [!IMPORTANT]
232
- > When adding the MCP server manually, you should add some extra instructions in your CLAUDE.md/AGENTS.md files to inform the agent about Backlog.md.
234
+ > When adding the MCP server manually, you should add some extra instructions in your CLAUDE.md/AGENTS.md files to inform the agent about Backlog.
233
235
  > This step is not required when using `backlog init` as it adds these instructions automatically.
234
- > Backlog.md's instructions for agents are available at [`/src/guidelines/mcp/agent-nudge.md`](/src/guidelines/mcp/agent-nudge.md).
235
-
236
+ > Backlog's instructions for agents are available at [`/src/guidelines/mcp/agent-nudge.md`](/src/guidelines/mcp/agent-nudge.md).
236
237
 
237
- Once connected, agents can read the Backlog.md workflow instructions via the resource `backlog://docs/task-workflow`.
238
+ Once connected, agents can read the Backlog workflow instructions via the resource `backlog://docs/task-workflow`.
238
239
  Use `/mcp` command in your AI tool (Claude Code, Codex, Kiro) to verify if the connection is working.
239
240
 
240
241
  ---
@@ -243,7 +244,7 @@ Use `/mcp` command in your AI tool (Claude Code, Codex, Kiro) to verify if the c
243
244
 
244
245
  Full command reference — task management, search, board, docs, decisions, and more: **[CLI-INSTRUCTIONS.md](CLI-INSTRUCTIONS.md)**
245
246
 
246
- Quick examples: `backlog task create`, `backlog task list`, `backlog task edit`, `backlog search`, `backlog board`, `backlog server`, `backlog service start`.
247
+ Quick examples: `backlog task create`, `backlog task list`, `backlog task edit`, `backlog search`, `backlog board`, `backlog server`, `backlog service start`, `backlog project switch` (switch between projects in the global store).
247
248
 
248
249
  Full help: `backlog --help`
249
250
 
@@ -251,7 +252,7 @@ Full help: `backlog --help`
251
252
 
252
253
  ## <img src="./.github/configuration-256.png" alt="Configuration" width="28" height="28" align="center"> Configuration
253
254
 
254
- Backlog.md merges the following layers (highest → lowest):
255
+ Backlog merges the following layers (highest → lowest):
255
256
 
256
257
  1. CLI flags
257
258
  2. Project config file (`config.yml` inside the project's global-store slot)
@@ -260,34 +261,36 @@ Backlog.md merges the following layers (highest → lowest):
260
261
  ### Interactive wizard (`backlog init` advanced settings)
261
262
 
262
263
  When you run `backlog init` and answer "Yes" at the advanced settings prompt, an interactive wizard walks through the project configuration surface:
264
+
263
265
  - Definition of Done defaults: interactively add/remove/reorder/clear project-level `definition_of_done` checklist items.
264
266
  - Web UI defaults: choose `defaultPort` and whether `autoOpenBrowser` should run.
265
267
 
266
- Answering "No" applies the safe defaults that ship with Backlog.md (`defaultPort=6420`, `autoOpenBrowser=true`). When you revisit `backlog init`, the wizard pre-populates prompts with your current values so you can adjust only what changed.
268
+ Answering "No" applies the safe defaults that ship with Backlog (`defaultPort=6420`, `autoOpenBrowser=true`). When you revisit `backlog init`, the wizard pre-populates prompts with your current values so you can adjust only what changed.
267
269
 
268
270
  Projects live in the global store, not in a Git repo. CLI, Web, and MCP workflows never depend on a Git repository.
269
271
 
270
272
  To change project config later, use the Web UI Settings page or edit the project config file directly (see below).
271
273
 
272
- ### Machine-level config (`~/.config/backlog.md/config.yml`)
274
+ ### Machine-level config (`~/.config/backlog/config.yml`)
273
275
 
274
- Some settings live outside any project and apply across all repositories on the machine. Create or edit `~/.config/backlog.md/config.yml` directly — the CLI does not write to this file.
276
+ Some settings live outside any project and apply across all repositories on the machine. Create or edit `~/.config/backlog/config.yml` directly — the CLI does not write to this file.
275
277
 
276
278
  **`globalStore`** — redirect all backlog storage to a single external directory instead of creating a `backlog/` folder inside each code repo:
277
279
 
278
280
  ```yaml
279
- # ~/.config/backlog.md/config.yml
281
+ # ~/.config/backlog/config.yml
280
282
  globalStore: /path/to/my/backlog-store
281
283
  ```
282
284
 
283
285
  When `globalStore` is set:
286
+
284
287
  - `backlog init` creates `<globalStore>/<repo-basename>/` instead of `<repo>/backlog/`.
285
288
  - All task reads and writes go to the external slot — the code repo is never touched.
286
289
  - `git log` in your code repo stays clean.
287
- - The `globalStore` directory must exist before running `backlog init`. Backlog.md will not create it.
290
+ - The `globalStore` directory must exist before running `backlog init`. Backlog will not create it.
288
291
  - If a local `backlog/` or `.backlog/` folder already exists in the repo, it wins and the global store is ignored for that project.
289
292
 
290
- The current `globalStore` value (or `(not set)`) is whatever you have written in `~/.config/backlog.md/config.yml`.
293
+ The current `globalStore` value (or `(not set)`) is whatever you have written in `~/.config/backlog/config.yml`.
291
294
 
292
295
  To override the config directory path (useful in tests or CI), set the `BACKLOG_MACHINE_CONFIG_DIR` environment variable.
293
296
 
@@ -322,4 +325,4 @@ Forked from [MrLesk/Backlog.md](https://github.com/MrLesk/Backlog.md) by Alex Ga
322
325
 
323
326
  ### License
324
327
 
325
- Backlog.md is released under the **MIT License** – do anything, just give credit. See [LICENSE](LICENSE).
328
+ Backlog is released under the **MIT License** – do anything, just give credit. See [LICENSE](LICENSE).
package/backlog.exe CHANGED
Binary file
package/package.json CHANGED
@@ -1,8 +1,11 @@
1
1
  {
2
2
  "name": "@ugudlado1/backlog-windows-x64",
3
- "version": "2.0.2",
3
+ "version": "2.1.8",
4
4
  "os": ["win32"],
5
5
  "cpu": ["x64"],
6
6
  "files": ["backlog.exe","package.json","LICENSE"],
7
- "repository": { "type": "git", "url": "https://github.com/ugudlado/backlog" }
7
+ "repository": {
8
+ "type": "git",
9
+ "url": "https://github.com/ugudlado/backlog"
10
+ }
8
11
  }