epiq 0.7.4 → 0.7.6

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "epiq",
3
- "version": "0.7.4",
3
+ "version": "0.7.6",
4
4
  "license": "MIT",
5
5
  "type": "module",
6
6
  "description": "EPIQ - CLI based issue tracker",
package/readme.md CHANGED
@@ -56,13 +56,27 @@ These design choices result in a system that is:
56
56
 
57
57
  ## Installation
58
58
 
59
- Install globally via npm:
59
+ ### Quick install
60
+
61
+ A single self-contained binary — no Node.js required:
62
+
63
+ ```bash
64
+ curl -fsSL https://raw.githubusercontent.com/ljtn/epiq/main/install.sh | sh
65
+ ```
66
+
67
+ Supports macOS (Intel & Apple Silicon) and Linux (x64 & arm64).
68
+
69
+ Installs to `~/.local/bin` by default. Override with `EPIQ_INSTALL_DIR` (or `XDG_BIN_HOME`); pin a version with `EPIQ_VERSION=v0.7.5`.
70
+
71
+ ### Via npm
72
+
73
+ If you already have Node.js (18+):
60
74
 
61
75
  ```bash
62
76
  npm install --global epiq
63
77
  ```
64
78
 
65
- Verify:
79
+ ### Verify
66
80
 
67
81
  ```bash
68
82
  epiq --version
@@ -157,26 +171,38 @@ Clear all filters with `:filter clear`
157
171
 
158
172
  ## MCP & Agent Compatibility
159
173
 
160
- Epiq provides a MCP (Model Context Protocol) server for agents to interact with, making it easy to plug into modern agent frameworks.
174
+ Epiq provides a MCP (Model Context Protocol) server for agents to interact with, making it easy to plug into modern agent frameworks. The server is exposed by the `epiq-mcp` binary that ships with the package.
175
+
176
+ ### Claude Code
161
177
 
162
- To register Epiq with MCP-compatible clients (e.g. Claude Desktop), add it as a server using the `epiq-mcp` binary. Example configuration in your `~/.claude.json`:
178
+ The reliable way to register the server is with the `claude mcp add` command it writes to the correct config file for you, so you don't have to hand-edit JSON:
179
+
180
+ ```bash
181
+ # Available everywhere (recommended)
182
+ claude mcp add --scope user epiq -- npx -y -p epiq epiq-mcp
183
+
184
+ # Or only in the current project
185
+ claude mcp add epiq -- npx -y -p epiq epiq-mcp
186
+ ```
187
+
188
+ Use `--scope user` to make Epiq available in every directory; omit it to register Epiq only for the current project. Verify the connection with `claude mcp list` (it should report `epiq … ✔ Connected`). MCP servers are loaded at startup, so **restart Claude Code** after adding the server before its tools become available.
189
+
190
+ ### Other MCP clients
191
+
192
+ For clients that are configured by hand, add the following to the client's MCP config file — note this is **not** the same as Claude Code's `~/.claude.json`; Claude Desktop uses `claude_desktop_config.json`:
163
193
 
164
194
  ```json
165
- "mcpServers": {
166
-
167
- "epiq": {
168
- "command": "npx",
169
- "args": [
170
- "-y",
171
- "-p",
172
- "epiq",
173
- "epiq-mcp"
174
- ]
195
+ {
196
+ "mcpServers": {
197
+ "epiq": {
198
+ "command": "npx",
199
+ "args": ["-y", "-p", "epiq", "epiq-mcp"]
200
+ }
175
201
  }
176
-
177
202
  }
178
203
  ```
179
204
 
205
+
180
206
  Once registered, agents can interact with your local Epiq instance through the MCP.
181
207
 
182
208
  ---