epicd-windows-arm64 1.48.16 → 1.49.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 +26 -27
- package/epicd.exe +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,15 +2,15 @@
|
|
|
2
2
|
<p align="center">Markdown‑native Task Manager & Kanban visualizer for any Git repository</p>
|
|
3
3
|
|
|
4
4
|
<p align="center">
|
|
5
|
-
<code>npm i -g epicd</code> or <code>bun add -g epicd</code>
|
|
5
|
+
<code>npm i -g epicd</code> or <code>bun add -g epicd</code>
|
|
6
6
|
</p>
|
|
7
7
|
|
|
8
|
-

|
|
9
9
|
|
|
10
10
|
|
|
11
11
|
---
|
|
12
12
|
|
|
13
|
-
> **
|
|
13
|
+
> **epicd** turns any folder with a Git repo into a **self‑contained project board**
|
|
14
14
|
> powered by plain Markdown files and a zero‑config CLI.
|
|
15
15
|
> Built for **spec‑driven AI development** — structure your tasks so AI agents deliver predictable results.
|
|
16
16
|
|
|
@@ -31,7 +31,7 @@
|
|
|
31
31
|
|
|
32
32
|
* 📤 **Board export** -- `epicd board export` creates shareable markdown reports
|
|
33
33
|
|
|
34
|
-
* 🔒 **100 % private & offline** --
|
|
34
|
+
* 🔒 **100 % private & offline** -- epicd lives entirely inside your repo and you can manage everything locally
|
|
35
35
|
|
|
36
36
|
* 💻 **Cross-platform** -- runs on macOS, Linux, and Windows
|
|
37
37
|
|
|
@@ -46,7 +46,6 @@
|
|
|
46
46
|
# Install
|
|
47
47
|
bun i -g epicd
|
|
48
48
|
# or: npm i -g epicd
|
|
49
|
-
# or: brew install backlog-md
|
|
50
49
|
|
|
51
50
|
# Initialize in any Git repo
|
|
52
51
|
epicd init "My Awesome Project"
|
|
@@ -58,9 +57,9 @@ epicd init "Personal Planning" --no-git
|
|
|
58
57
|
The init wizard will ask how you want to connect AI tools:
|
|
59
58
|
- **CLI instructions** (recommended) — creates a short instruction file that tells agents to run `epicd instructions overview`.
|
|
60
59
|
- **MCP connector** — optionally auto-configures Claude Code, Codex, Gemini CLI, Kiro or Cursor for teams that prefer MCP.
|
|
61
|
-
- **Skip** — no AI setup; use
|
|
60
|
+
- **Skip** — no AI setup; use epicd purely as a task manager.
|
|
62
61
|
|
|
63
|
-
|
|
62
|
+
epicd data is stored in a project-local task 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
63
|
|
|
65
64
|
---
|
|
66
65
|
|
|
@@ -72,7 +71,7 @@ After running `epicd init`, agents should start by running `epicd instructions o
|
|
|
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
|
|
74
|
+
> I want to add a search feature to the web view that searches tasks, docs, and decisions. Please decompose this into small epicd tasks.
|
|
76
75
|
|
|
77
76
|
> [!NOTE]
|
|
78
77
|
> **Review checkpoint #1** — read the task descriptions and acceptance criteria.
|
|
@@ -98,7 +97,7 @@ If the output is not good enough: clear the plan/notes/final summary, refine the
|
|
|
98
97
|
|
|
99
98
|
### Working without AI agents
|
|
100
99
|
|
|
101
|
-
Use
|
|
100
|
+
Use epicd as a standalone task manager from the terminal or browser.
|
|
102
101
|
|
|
103
102
|
```bash
|
|
104
103
|
# Create and refine tasks
|
|
@@ -115,7 +114,7 @@ epicd board
|
|
|
115
114
|
epicd browser
|
|
116
115
|
```
|
|
117
116
|
|
|
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
|
|
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 epicd 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
118
|
|
|
120
119
|
**Learn more:** [CLI reference](CLI-INSTRUCTIONS.md) | [Advanced configuration](ADVANCED-CONFIG.md)
|
|
121
120
|
|
|
@@ -147,14 +146,14 @@ epicd browser --no-open
|
|
|
147
146
|
|
|
148
147
|

|
|
149
148
|
|
|
150
|
-
To keep the Web UI running as an auto-starting local service, see [Running
|
|
149
|
+
To keep the Web UI running as an auto-starting local service, see [Running epicd as a Service](.epicd/docs/doc-003%20-%20Running-Backlog-Browser-as-a-Service.md).
|
|
151
150
|
|
|
152
151
|
---
|
|
153
152
|
|
|
154
153
|
## 🔧 MCP Integration (Model Context Protocol)
|
|
155
154
|
|
|
156
155
|
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 `epicd init` (even if you already initialized
|
|
156
|
+
You can run `epicd init` (even if you already initialized epicd) and choose MCP integration, or follow the manual steps below.
|
|
158
157
|
|
|
159
158
|
### Client guides
|
|
160
159
|
|
|
@@ -162,7 +161,7 @@ You can run `epicd init` (even if you already initialized Backlog.md) and choose
|
|
|
162
161
|
<summary><strong>Claude Code</strong></summary>
|
|
163
162
|
|
|
164
163
|
```bash
|
|
165
|
-
claude mcp add
|
|
164
|
+
claude mcp add epicd --scope user -- epicd mcp start
|
|
166
165
|
```
|
|
167
166
|
|
|
168
167
|
</details>
|
|
@@ -171,7 +170,7 @@ You can run `epicd init` (even if you already initialized Backlog.md) and choose
|
|
|
171
170
|
<summary><strong>Codex</strong></summary>
|
|
172
171
|
|
|
173
172
|
```bash
|
|
174
|
-
codex mcp add
|
|
173
|
+
codex mcp add epicd -- epicd mcp start
|
|
175
174
|
```
|
|
176
175
|
|
|
177
176
|
</details>
|
|
@@ -180,7 +179,7 @@ You can run `epicd init` (even if you already initialized Backlog.md) and choose
|
|
|
180
179
|
<summary><strong>Gemini CLI</strong></summary>
|
|
181
180
|
|
|
182
181
|
```bash
|
|
183
|
-
gemini mcp add
|
|
182
|
+
gemini mcp add epicd -s user epicd mcp start
|
|
184
183
|
```
|
|
185
184
|
|
|
186
185
|
</details>
|
|
@@ -189,39 +188,39 @@ You can run `epicd init` (even if you already initialized Backlog.md) and choose
|
|
|
189
188
|
<summary><strong>Kiro</strong></summary>
|
|
190
189
|
|
|
191
190
|
```bash
|
|
192
|
-
kiro-cli mcp add --scope global --name
|
|
191
|
+
kiro-cli mcp add --scope global --name epicd --command epicd --args mcp,start
|
|
193
192
|
```
|
|
194
193
|
|
|
195
194
|
</details>
|
|
196
195
|
|
|
197
|
-
Use the shared `
|
|
196
|
+
Use the shared `epicd` server name everywhere. The server finds the active project from your client's MCP roots, and re-resolves when you switch workspace or worktree. Until it finds one, it serves `epicd://init-required`. A single user-scope server covers every repo.
|
|
198
197
|
|
|
199
198
|
### Manual config
|
|
200
199
|
|
|
201
200
|
```json
|
|
202
201
|
{
|
|
203
202
|
"mcpServers": {
|
|
204
|
-
"
|
|
203
|
+
"epicd": {
|
|
205
204
|
"command": "epicd",
|
|
206
205
|
"args": ["mcp", "start"],
|
|
207
206
|
"env": {
|
|
208
|
-
"
|
|
207
|
+
"EPICD_CWD": "/absolute/path/to/your/project"
|
|
209
208
|
}
|
|
210
209
|
}
|
|
211
210
|
}
|
|
212
211
|
}
|
|
213
212
|
```
|
|
214
213
|
|
|
215
|
-
Set `
|
|
214
|
+
Set `EPICD_CWD` to pin the server to one project and stop workspace following. Use it to always target the same backlog, or when your client can't report MCP roots.
|
|
216
215
|
If your IDE supports custom args but not env vars, you can also use `["mcp", "start", "--cwd", "/absolute/path/to/your/project"]`.
|
|
217
216
|
|
|
218
217
|
> [!IMPORTANT]
|
|
219
|
-
> When adding the MCP server manually, add a short instruction to your CLAUDE.md/AGENTS.md files telling agents to read `
|
|
218
|
+
> When adding the MCP server manually, add a short instruction to your CLAUDE.md/AGENTS.md files telling agents to read `epicd://workflow/overview`.
|
|
220
219
|
> This step is not required when using `epicd init` as it adds these instructions automatically.
|
|
221
220
|
> For CLI-based setups, use `epicd instructions overview` to fetch the current workflow guidance.
|
|
222
221
|
|
|
223
222
|
|
|
224
|
-
Once connected, agents can read the
|
|
223
|
+
Once connected, agents can read the epicd workflow instructions via `epicd://workflow/overview`, with detailed guides at `epicd://workflow/task-creation`, `epicd://workflow/task-execution`, and `epicd://workflow/task-finalization`.
|
|
225
224
|
Use `/mcp` command in your AI tool (Claude Code, Codex, Kiro) to verify if the connection is working.
|
|
226
225
|
|
|
227
226
|
---
|
|
@@ -238,12 +237,12 @@ Full help: `epicd --help`
|
|
|
238
237
|
|
|
239
238
|
## <img src="./.github/configuration-256.png" alt="Configuration" width="28" height="28" align="center"> Configuration
|
|
240
239
|
|
|
241
|
-
|
|
240
|
+
epicd merges the following layers (highest → lowest):
|
|
242
241
|
|
|
243
242
|
1. CLI flags
|
|
244
243
|
2. Project config file:
|
|
245
244
|
- `backlog.config.yml` when present
|
|
246
|
-
- otherwise `backlog/config.yml
|
|
245
|
+
- otherwise `.epicd/config.yml`, `backlog/config.yml`, or `.backlog/config.yml`
|
|
247
246
|
3. Built‑ins
|
|
248
247
|
|
|
249
248
|
### Interactive wizard (`epicd config`)
|
|
@@ -256,14 +255,14 @@ Run `epicd config` with no arguments to launch the full interactive wizard. This
|
|
|
256
255
|
- Definition of Done defaults: interactively add/remove/reorder/clear project-level `definition_of_done` checklist items.
|
|
257
256
|
- Web UI defaults: choose `defaultPort` and whether `autoOpenBrowser` should run.
|
|
258
257
|
|
|
259
|
-
Skipping the wizard (answering "No" during init) applies the safe defaults that ship with
|
|
258
|
+
Skipping the wizard (answering "No" during init) applies the safe defaults that ship with epicd:
|
|
260
259
|
- `checkActiveBranches=true`, `remoteOperations=true`, `activeBranchDays=30`.
|
|
261
260
|
- `autoCommit=false`, `bypassGitHooks=false`.
|
|
262
261
|
- `zeroPaddedIds` disabled.
|
|
263
262
|
- `defaultEditor` unset (falls back to your environment).
|
|
264
263
|
- `defaultPort=6420`, `autoOpenBrowser=true`.
|
|
265
264
|
|
|
266
|
-
For filesystem-only projects, run `epicd init --no-git`.
|
|
265
|
+
For filesystem-only projects, run `epicd init --no-git`. epicd 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
266
|
|
|
268
267
|
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
268
|
|
|
@@ -294,4 +293,4 @@ For the full configuration reference (all options, commands, and detailed notes)
|
|
|
294
293
|
|
|
295
294
|
### License
|
|
296
295
|
|
|
297
|
-
|
|
296
|
+
epicd is released under the **MIT License** – do anything, just give credit. See [LICENSE](LICENSE).
|
package/epicd.exe
CHANGED
|
Binary file
|