You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-3Lines changed: 17 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -69,9 +69,12 @@ docket next
69
69
70
70
# View the Kanban board
71
71
docket board
72
+
73
+
# Browse issues in the interactive terminal UI
74
+
docket ui
72
75
```
73
76
74
-
**AI agents:** add `--json` to any command for structured, machine-readable output:
77
+
**AI agents:** add `--json` to supported non-interactive commands for structured, machine-readable output:
75
78
76
79
```bash
77
80
docket next --json
@@ -81,14 +84,16 @@ docket issue list --json -s todo -s in-progress
81
84
## Why Docket?
82
85
83
86
-**No servers, no network** — everything is a local SQLite file in `.docket/`. Works offline, on planes, in CI.
84
-
-**AI-native from day one** — every command supports`--json` with a consistent envelope. Agents can create, query, plan, and update issues without parsing human text.
87
+
-**AI-native from day one** — machine-readable commands support`--json` with a consistent envelope. Agents can create, query, plan, and update issues without parsing human text.
85
88
-**Dependency-aware planning** — `docket next` and `docket plan` use a DAG to surface only unblocked, work-ready issues. No stale sprint boards.
86
89
-**Zero configuration** — `docket init` and you're done. No accounts, no tokens, no YAML.
87
90
-**Portable data** — the `.docket/` directory travels with your repo. Clone it, fork it, archive it.
88
91
89
92
## AI Agent Integration
90
93
91
-
Every command supports `--json` for structured, machine-readable output. All JSON responses use a consistent envelope:
94
+
Most commands support `--json` for structured, machine-readable output. All JSON responses use a consistent envelope:
95
+
96
+
`docket ui` is the exception: it opens a read-only interactive terminal UI, requires a real TTY, and rejects `--json`.
@@ -117,6 +122,12 @@ Run `docket next --json` to find work. Move issues to `in-progress` before start
117
122
118
123
Any agent that can run shell commands works with Docket. Point it at `docket next --json` to discover work items, and use `docket issue show <id> --json` to get full context before starting a task. The consistent JSON envelope (`ok`, `data`, `error`, `code`) makes parsing straightforward in any language.
119
124
125
+
### Interactive UI
126
+
127
+
Use `docket ui` when you want an interactive browser instead of command output. It opens a read-only terminal UI for list and board browsing, requires an interactive terminal, and does not support `--json`.
128
+
129
+
If you need to debug terminal-specific behavior, set `DOCKET_UI_DEBUG_LOG=/tmp/docket-ui.log` before running `docket ui`.
130
+
120
131
<details>
121
132
<summary>Verbose JSON examples</summary>
122
133
@@ -222,6 +233,8 @@ docket issue list --json -s todo -s in-progress -p high
222
233
--quiet, -q Suppress non-essential output
223
234
```
224
235
236
+
`docket ui` is interactive-only and rejects `--json`.
237
+
225
238
### Issue Commands (`docket issue` / `docket i`)
226
239
227
240
| Command | Description |
@@ -290,6 +303,7 @@ docket issue list --json -s todo -s in-progress -p high
290
303
|`docket config`| Show current configuration (database path, schema version, etc.) |
291
304
|`docket version`| Print version, commit, and build date |
292
305
|`docket stats`| Show summary statistics for the issue database |
306
+
|`docket ui`| Browse issues in an interactive terminal UI |
0 commit comments