epicd-darwin-x64 1.48.6 β 1.48.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.
- package/README.md +36 -36
- package/epicd +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
<code>npm i -g epicd</code> or <code>bun add -g epicd</code> or <code>brew install backlog-md</code> or <code>nix run github:MrLesk/Backlog.md</code>
|
|
6
6
|
</p>
|
|
7
7
|
|
|
8
|
-

|
|
9
9
|
|
|
10
10
|
|
|
11
11
|
---
|
|
@@ -20,16 +20,16 @@
|
|
|
20
20
|
|
|
21
21
|
* π€ **AI-Ready** -- Works with Claude Code, Gemini CLI, Codex, Kiro & any other MCP or CLI compatible AI assistants
|
|
22
22
|
|
|
23
|
-
* π **Instant terminal Kanban** -- `
|
|
23
|
+
* π **Instant terminal Kanban** -- `epicd board` paints a live board in your shell
|
|
24
24
|
|
|
25
|
-
* π **Modern web interface** -- `
|
|
25
|
+
* π **Modern web interface** -- `epicd browser` launches a sleek web UI for visual task management
|
|
26
26
|
|
|
27
|
-
* π **Powerful search** -- fuzzy search across tasks, docs & decisions with `
|
|
27
|
+
* π **Powerful search** -- fuzzy search across tasks, docs & decisions with `epicd search`
|
|
28
28
|
|
|
29
29
|
* π **Rich query commands** -- view, list, filter, or archive tasks with ease
|
|
30
30
|
* β
**Definition of Done defaults** -- add a reusable checklist to every new task
|
|
31
31
|
|
|
32
|
-
* π€ **Board export** -- `
|
|
32
|
+
* π€ **Board export** -- `epicd board export` creates shareable markdown reports
|
|
33
33
|
|
|
34
34
|
* π **100 % private & offline** -- backlog lives entirely inside your repo and you can manage everything locally
|
|
35
35
|
|
|
@@ -49,25 +49,25 @@ bun i -g epicd
|
|
|
49
49
|
# or: brew install backlog-md
|
|
50
50
|
|
|
51
51
|
# Initialize in any Git repo
|
|
52
|
-
|
|
52
|
+
epicd init "My Awesome Project"
|
|
53
53
|
|
|
54
54
|
# Or initialize without Git for local/non-code projects
|
|
55
|
-
|
|
55
|
+
epicd init "Personal Planning" --no-git
|
|
56
56
|
```
|
|
57
57
|
|
|
58
58
|
The init wizard will ask how you want to connect AI tools:
|
|
59
|
-
- **CLI instructions** (recommended) β creates a short instruction file that tells agents to run `
|
|
59
|
+
- **CLI instructions** (recommended) β creates a short instruction file that tells agents to run `epicd instructions overview`.
|
|
60
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
|
-
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: `
|
|
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: `epicd init --no-git` creates a filesystem-only project and disables cross-branch checks, remote operations, and auto-commit.
|
|
64
64
|
|
|
65
65
|
---
|
|
66
66
|
|
|
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 `
|
|
70
|
+
After running `epicd init`, agents should start by running `epicd 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
|
|
|
@@ -102,20 +102,20 @@ Use Backlog.md as a standalone task manager from the terminal or browser.
|
|
|
102
102
|
|
|
103
103
|
```bash
|
|
104
104
|
# Create and refine tasks
|
|
105
|
-
|
|
106
|
-
|
|
105
|
+
epicd task create "Render markdown as kanban"
|
|
106
|
+
epicd task edit BACK-1 -d "Detailed context" --ac "Clear acceptance criteria"
|
|
107
107
|
|
|
108
108
|
# Track work
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
109
|
+
epicd task list -s "To Do"
|
|
110
|
+
epicd task edit BACK-1 --comment "Can we split the UI work into a separate PR?" --comment-author @sara
|
|
111
|
+
epicd search "kanban"
|
|
112
|
+
epicd board
|
|
113
113
|
|
|
114
114
|
# Work visually in the browser
|
|
115
|
-
|
|
115
|
+
epicd 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 `
|
|
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 `epicd 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
|
|
|
@@ -127,13 +127,13 @@ Launch a modern, responsive web interface for visual task management:
|
|
|
127
127
|
|
|
128
128
|
```bash
|
|
129
129
|
# Start the web server (opens browser automatically)
|
|
130
|
-
|
|
130
|
+
epicd browser
|
|
131
131
|
|
|
132
132
|
# Custom port
|
|
133
|
-
|
|
133
|
+
epicd browser --port 8080
|
|
134
134
|
|
|
135
135
|
# Don't open browser automatically
|
|
136
|
-
|
|
136
|
+
epicd browser --no-open
|
|
137
137
|
```
|
|
138
138
|
|
|
139
139
|
**Features:**
|
|
@@ -154,7 +154,7 @@ To keep the Web UI running as an auto-starting local service, see [Running Backl
|
|
|
154
154
|
## π§ MCP Integration (Model Context Protocol)
|
|
155
155
|
|
|
156
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 `
|
|
157
|
+
You can run `epicd 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
|
|
|
@@ -162,7 +162,7 @@ You can run `backlog init` (even if you already initialized Backlog.md) and choo
|
|
|
162
162
|
<summary><strong>Claude Code</strong></summary>
|
|
163
163
|
|
|
164
164
|
```bash
|
|
165
|
-
claude mcp add backlog --scope user --
|
|
165
|
+
claude mcp add backlog --scope user -- epicd mcp start
|
|
166
166
|
```
|
|
167
167
|
|
|
168
168
|
</details>
|
|
@@ -171,7 +171,7 @@ You can run `backlog init` (even if you already initialized Backlog.md) and choo
|
|
|
171
171
|
<summary><strong>Codex</strong></summary>
|
|
172
172
|
|
|
173
173
|
```bash
|
|
174
|
-
codex mcp add backlog --
|
|
174
|
+
codex mcp add backlog -- epicd mcp start
|
|
175
175
|
```
|
|
176
176
|
|
|
177
177
|
</details>
|
|
@@ -180,7 +180,7 @@ You can run `backlog init` (even if you already initialized Backlog.md) and choo
|
|
|
180
180
|
<summary><strong>Gemini CLI</strong></summary>
|
|
181
181
|
|
|
182
182
|
```bash
|
|
183
|
-
gemini mcp add backlog -s user
|
|
183
|
+
gemini mcp add backlog -s user epicd mcp start
|
|
184
184
|
```
|
|
185
185
|
|
|
186
186
|
</details>
|
|
@@ -189,7 +189,7 @@ You can run `backlog init` (even if you already initialized Backlog.md) and choo
|
|
|
189
189
|
<summary><strong>Kiro</strong></summary>
|
|
190
190
|
|
|
191
191
|
```bash
|
|
192
|
-
kiro-cli mcp add --scope global --name backlog --command
|
|
192
|
+
kiro-cli mcp add --scope global --name backlog --command epicd --args mcp,start
|
|
193
193
|
```
|
|
194
194
|
|
|
195
195
|
</details>
|
|
@@ -202,7 +202,7 @@ Use the shared `backlog` server name everywhere. The server finds the active pro
|
|
|
202
202
|
{
|
|
203
203
|
"mcpServers": {
|
|
204
204
|
"backlog": {
|
|
205
|
-
"command": "
|
|
205
|
+
"command": "epicd",
|
|
206
206
|
"args": ["mcp", "start"],
|
|
207
207
|
"env": {
|
|
208
208
|
"BACKLOG_CWD": "/absolute/path/to/your/project"
|
|
@@ -217,8 +217,8 @@ If your IDE supports custom args but not env vars, you can also use `["mcp", "st
|
|
|
217
217
|
|
|
218
218
|
> [!IMPORTANT]
|
|
219
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
|
-
> This step is not required when using `
|
|
221
|
-
> For CLI-based setups, use `
|
|
220
|
+
> This step is not required when using `epicd init` as it adds these instructions automatically.
|
|
221
|
+
> For CLI-based setups, use `epicd instructions overview` to fetch the current workflow guidance.
|
|
222
222
|
|
|
223
223
|
|
|
224
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`.
|
|
@@ -230,9 +230,9 @@ 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: `
|
|
233
|
+
Quick examples: `epicd`, `epicd instructions`, `epicd task create`, `epicd task list`, `epicd task edit`, `epicd milestone add`, `epicd milestone rename`, `epicd milestone remove`, `epicd search`, `epicd board`, `epicd browser`.
|
|
234
234
|
|
|
235
|
-
Full help: `
|
|
235
|
+
Full help: `epicd --help`
|
|
236
236
|
|
|
237
237
|
---
|
|
238
238
|
|
|
@@ -246,9 +246,9 @@ Backlog.md merges the following layers (highest β lowest):
|
|
|
246
246
|
- otherwise `backlog/config.yml` or `.backlog/config.yml`
|
|
247
247
|
3. Builtβins
|
|
248
248
|
|
|
249
|
-
### Interactive wizard (`
|
|
249
|
+
### Interactive wizard (`epicd config`)
|
|
250
250
|
|
|
251
|
-
Run `
|
|
251
|
+
Run `epicd config` with no arguments to launch the full interactive wizard. This is the same experience triggered from `epicd init` when you opt into advanced settings, and it walks through the complete configuration surface:
|
|
252
252
|
- Cross-branch accuracy: `checkActiveBranches`, `remoteOperations`, and `activeBranchDays`.
|
|
253
253
|
- Git workflow: `autoCommit` and `bypassGitHooks`.
|
|
254
254
|
- ID formatting: enable or size `zeroPaddedIds`.
|
|
@@ -263,13 +263,13 @@ Skipping the wizard (answering "No" during init) applies the safe defaults that
|
|
|
263
263
|
- `defaultEditor` unset (falls back to your environment).
|
|
264
264
|
- `defaultPort=6420`, `autoOpenBrowser=true`.
|
|
265
265
|
|
|
266
|
-
For filesystem-only projects, run `
|
|
266
|
+
For filesystem-only projects, run `epicd 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.
|
|
267
267
|
|
|
268
|
-
Whenever you revisit `
|
|
268
|
+
Whenever you revisit `epicd init` or rerun `epicd config`, the wizard pre-populates prompts with your current values so you can adjust only what changed.
|
|
269
269
|
|
|
270
270
|
### Definition of Done defaults
|
|
271
271
|
|
|
272
|
-
Set project-wide DoD items with `
|
|
272
|
+
Set project-wide DoD items with `epicd config` (or during `epicd init` advanced setup), in the Web UI (Settings β Definition of Done Defaults), or by editing the project config file directly:
|
|
273
273
|
|
|
274
274
|
```yaml
|
|
275
275
|
definition_of_done:
|
package/epicd
CHANGED
|
Binary file
|