main 4509ec7

README.md RawHistoryFolder

todo — example zut extension (Go, interactive panel)

Demonstrates the interactive panel API plus a companion tool the model can call. The slash command opens a persistent todo panel; the tool lets zut read and update the same todo list.

Requirements

Go 1.22+.

Install

From this directory:

zut ext install .

The example is configured to run directly from source:

{
  "exec": "go",
  "args": ["run", "."]
}

That avoids architecture-specific binaries when sharing the example, as long as Go is installed.

Optional local build

cd examples/extensions/todo
go build -o todo-panel .

If you do build it, change extension.json back to:

{
  "exec": "./todo-panel"
}

Use

In zut:

  • /todo opens the panel

Features

  • /todo opens the panel
  • panel keys:
    • up/down - move
    • a - add with typed text
    • e - edit selected todo
    • x - toggle done
    • d - delete
    • r - redraw
    • esc - close panel
  • persistent storage in the extension data directory as todos.json
  • LLM tool: todo_manage
    • list
    • add
    • complete
    • edit
    • remove

Natural-language examples

  • Create a new entry named "Call Georg" on my to-do list.
  • Complete task "Call Georg".
  • Edit task "Call Georg" to "Call Georg tomorrow".
  • Remove task "Call Georg".

See also

  • examples/extensions/hello — Go SDK slash commands
  • examples/extensions/weather — Go SDK tool example
  • examples/extensions/guard — Go SDK intercept example
  • examples/extensions/scratchpad — TypeScript commands + tool
  • docs/extensions.md — full protocol reference
source
1# todo — example zut extension (Go, interactive panel)
2
3Demonstrates the interactive panel API plus a companion tool the model
4can call. The slash command opens a persistent todo panel; the tool lets
5zut read and update the same todo list.
6
7## Requirements
8
9Go 1.22+.
10
11## Install
12
13From this directory:
14
15```bash
16zut ext install .
17```
18
19The example is configured to run directly from source:
20
21```json
22{
23  "exec": "go",
24  "args": ["run", "."]
25}
26```
27
28That avoids architecture-specific binaries when sharing the example, as
29long as Go is installed.
30
31## Optional local build
32
33```bash
34cd examples/extensions/todo
35go build -o todo-panel .
36```
37
38If you do build it, change `extension.json` back to:
39
40```json
41{
42  "exec": "./todo-panel"
43}
44```
45
46## Use
47
48In zut:
49
50- `/todo` opens the panel
51
52## Features
53
54- `/todo` opens the panel
55- panel keys:
56  - up/down - move
57  - a - add with typed text
58  - e - edit selected todo
59  - x - toggle done
60  - d - delete
61  - r - redraw
62  - esc - close panel
63- persistent storage in the extension data directory as `todos.json`
64- LLM tool: `todo_manage`
65  - list
66  - add
67  - complete
68  - edit
69  - remove
70
71## Natural-language examples
72
73- Create a new entry named "Call Georg" on my to-do list.
74- Complete task "Call Georg".
75- Edit task "Call Georg" to "Call Georg tomorrow".
76- Remove task "Call Georg".
77
78## See also
79
80- `examples/extensions/hello` — Go SDK slash commands
81- `examples/extensions/weather` — Go SDK tool example
82- `examples/extensions/guard` — Go SDK intercept example
83- `examples/extensions/scratchpad` — TypeScript commands + tool
84- `docs/extensions.md` — full protocol reference

Keyboard shortcuts

Single-key shortcuts are on. ctrl k and esc work whatever this says.

ctrl k :
go to a section, branch, tag, file or repository
?
this list
j k
move the row cursor down / up
enter
open the row under the cursor; on Files, a directory opens or closes in place
↑ ↓ ← → home end
in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
l h
on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls
g g G
first / last row
/
filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
b
switch branch or tag
g s g f g c g b g m g i g r g a
tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
g h
home
w
wide mode: use the whole width of the screen, or not (remembered)
y
copy a permalink pinned to the commit
d u x
diff: split / unified / collapse or expand all
e E
diff: the whole file in view / every file, with the lines the hunks hide
n
merge request: next note in the diff
esc
close a dialog, leave a field

Branches 1

Tags 476

↑↓ moveenter openesc close