epiq 1.5.0 → 1.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "epiq",
-	"version": "1.5.0",
+	"version": "1.6.0",
 	"license": "MIT",
 	"type": "module",
 	"description": "EPIQ - ergonomic, distributed CLI-first issue tracker TUI ready for the agentic era",
@@ -39,9 +39,12 @@
 		"dev:start": "IS_LOCAL=true tsx source/Index.tsx",
 		"start": "IS_LOCAL=true tsx source/Index.tsx",
 		"start:gui": "IS_LOCAL=true tsx source/Index.tsx gui",
-		"test": "prettier --check \"**/*.{ts,tsx}\" && vitest run --coverage --exclude \"source/test/e2e/**\"",
-		"test:e2e:ci": "export IS_CI=true && npm run build:npm && vitest run source/test/e2e --no-file-parallelism",
-		"test:e2e": "docker run --rm -v \"$PWD\":/app -v /app/node_modules -w /app epiq-e2e npm run test:e2e:ci",
+		"test": "prettier --check \"**/*.{ts,tsx}\" && vitest run --coverage --exclude \"source/test/e2e/**\" --exclude \"source/test/e2e-collab/**\"",
+		"test:containers": "sh source/scripts/test-containers.sh",
+		"test:collab": "docker run --rm -v \"$PWD\":/app:ro -v /app/node_modules -w /app epiq-e2e npm run test:collab:ci",
+		"test:collab:ci": "vitest run source/test/e2e-collab/",
+		"test:e2e:ci": "export IS_CI=true && ([ -n \"${EPIQ_SKIP_BUILD:-}\" ] || npm run build:npm) && vitest run source/test/e2e/",
+		"test:e2e": "docker run --rm -e EPIQ_SKIP_BUILD -v \"$PWD\":/app -v /app/node_modules -w /app epiq-e2e npm run test:e2e:ci",
 		"test:gui": "playwright test",
 		"test:gui:ci": "npm run build:npm && playwright install --no-shell chromium && playwright test",
 		"build:e2e:image": "docker build -f source/test/e2e/Dockerfile -t epiq-e2e .",
@@ -61,6 +64,7 @@
 	],
 	"dependencies": {
 		"@modelcontextprotocol/sdk": "^1.29.0",
+		"@pierre/diffs": "^1.3.6",
 		"@xterm/headless": "^6.0.0",
 		"ink": "^6.8.0",
 		"meow": "^14.1.0",

package/readme.md

@@ -1,33 +1,32 @@
 # Epiq
 
-_Distributed terminal-native issue tracker backed by Git._
+_Issue tracking as code. Open source, distributed, local-first, and code-native._
 
-**[See docs →](https://ljtn.github.io/epiq/docs.html)**
+**[See docs →](https://ljtn.github.io/epiq/docs.html)** 
 
-Issue tracking is a core part of software development, but it often becomes a painful context-switching exercise with poor ergonomics. Epiq provides issue tracking as a portable, integrated part of the development environment, with access to all the powerful tooling developers are used to.
+Epiq provides issue tracking as a portable, integrated part of the development environment, with access to all the powerful tooling developers are used to.
 
-> Manage your projects in a visual terminal kanban board (or through the browser GUI), while keeping all state local, Git-backed, and versioned.
+> Manage your projects in a visual kanban board — in your terminal or in your browser — while keeping all state local, Git-backed, and versioned.
 
 With great attention to user ergonomics and developer experience, epiq strives to make project management painless and friction free.
 
-![Epiq cli gif view](https://raw.githubusercontent.com/ljtn/epiq/main/source/assets/epiq-cli.gif)
+![Epiq board with the time travel timeline](https://raw.githubusercontent.com/ljtn/epiq/main/source/assets/time-travel.png)
 
-## Terminal + Browser
+## Audit the workflow
+
+Agents now run whole sprints unattended. Because state is a full event log, you can replay the board to find out what moved when, who moved it, and what changed along the way.
 
-Epiq originated from the command line, but also features a browser interface powered by the same Git-backed event engine.
+## Terminal + Browser
 
-![Epiq gui view](https://raw.githubusercontent.com/ljtn/epiq/main/source/assets/epiq-gui.gif)
+Epiq originated from the command line and offers a first-class terminal experience, but also features a browser interface powered by the same Git-backed event engine.
 
 ## What is epiq?
 
 Epiq is a self hosted, vim-inspired issue tracker that brings developer experience to project management. It renders either as ASCII, or as a web GUI, and persists state as an immutable distributed event log, versioned and synchronized through Git.
 
-![Epiq cli kanban view](https://raw.githubusercontent.com/ljtn/epiq/main/source/assets/overview.png)
-![Epiq cli log view](https://raw.githubusercontent.com/ljtn/epiq/main/source/assets/log.png)
-
 ## Why Epiq?
 
-Most issue trackers live outside your workflow. Epiq brings issue tracking where you already work - your editor.
+Most issue trackers live outside your workflow. Instead of a centralized, managed service, Epiq keeps project state alongside your repository, where it travels with your code.
 
 These design choices result in a system that is:
 
@@ -39,16 +38,17 @@ These design choices result in a system that is:
 - **Command driven** — scriptable and automation-friendly, ready for the agentic era
 - **Versioned** — changes are tracked and recoverable through Git
 
-## Features
+## A Features
 
 - Issue tracking — track work in tickets with name, description, tags, assignees, history log, etc.
 - Ergonomics — fast keyboard-driven UX, command line with history, syntax highlighting etc.
 - Command palette — press `?` to open a scrollable overview of all available commands and descriptions
-- Time travel — inspect your board 1h, 1 week or 1 year ago
+- Time travel — inspect the board as it was 1h, 1 week or 1 year ago, or replay its history as an animation
 - Filtering — query issues by description, tags, assignees, etc.
 - Autocompletion — minimize typing, stay in flow, reuse previous commands
 - Multi-user — collaborative synchronization via Git
 - Traceable event log — state is a full history of every change ever made
+- Export — write the current board layout to markdown
 - Browser GUI — graphical interface powered by the same Git-backed state
 - MCP integration — Model Context Protocol support for agent interaction
 
@@ -115,6 +115,7 @@ epiq gui
 > - Authoritative Git state at `~/.epiq-global/worktrees/<id>`
 > - Updates your `.gitignore` to ignore local-only `.epiq/log/`
 >   Epiq manages a dedicated Git state branch and worktree automatically as the source of truth for synchronization.
+> - A local debug log at `.epiq/log/epiq.log` — check it first if sync, boot, or a Git operation is misbehaving.
 
 ## Usage Guide (TUI)
 
@@ -151,6 +152,12 @@ epiq gui
 
 Clear all filters with `:filter clear`
 
+### Time travel
+
+- Inspect the board as it was with `:peek <offset>`, where offset is `<n>h`, `d`, `w`, `mo` or `y` — so `:peek 3d` is the board three days ago. An absolute `YYYY-MM-DD` date works too. Step with `:peek prev|next`, and return with `:peek now`.
+- Where `:peek` shows a frozen snapshot, `:replay 1mo` plays history forward from that point as an animation. An optional second argument sets the playback duration, e.g. `:replay 1mo 30s`.
+- While peeking or replaying, the board is read-only.
+
 ### Close issue
 
 - Close issues with `:close`. This moves the issue to a special board named `Closed` which you can find if you navigate up (press `q`) a few times.
@@ -185,7 +192,25 @@ Use `--scope user` to make Epiq available in every directory; omit it to registe
 
 ### Skills
 
-Find skill at `.claude/skills/epiq/SKILL.md` that documents a recommended workflow for working the Epiq.
+Find skill at `.claude/skills/epiq/SKILL.md` that documents a recommended workflow for working the Epiq board.
+
+### Agent identity
+
+Every process — your TUI, your GUI, each agent's MCP server — writes as the user in `~/.epiq-global/config.json`, so by default the board cannot tell one agent from another. Give an agent its own identity with `EPIQ_USER_NAME`:
+
+```json
+{
+	"mcpServers": {
+		"epiq": {
+			"command": "npx",
+			"args": ["-y", "-p", "epiq", "epiq-mcp"],
+			"env": {"EPIQ_USER_NAME": "claude"}
+		}
+	}
+}
+```
+
+That agent then shows up in the contributor list, assigns itself rather than you, and authors its own events. The id is derived from the name, so one name is one contributor on every machine — reuse names instead of inventing one per session, or the registry fills with single-run identities. `EPIQ_USER_ID` pins the id explicitly (26 characters of Crockford base32) if you would rather choose it. Naming yourself changes nothing.
 
 ### Other MCP clients