1# clock — example zot extension (Node, no dependencies)
2
3A minimal TypeScript-style extension showing the wire protocol from
4the Node side without any SDK. Pure stdlib (`readline`, `process`).
5
6## Requirements
7
8Node 18 or newer (uses ESM). No `npm install` step.
9
10## Install
11
12From this directory:
13
14```bash
15zot ext install .
16```
17
18This copies the manifest + script into `$ZOT_HOME/extensions/clock/`.
19zot picks it up the next time you launch the TUI.
20
21## Use
22
23In zot:
24
25- `/now`              — extension pushes a styled note showing local
26                        and ISO time (no model call)
27- `/uptime`           — extension asks the agent to comment on how
28                        long the clock extension has been running
29- `/uptime caching`   — same, but the agent's comment is steered by
30                        the trailing args
31
32## Why JavaScript and not TypeScript
33
34The file uses JSDoc types (`@typedef`, `@param`) so it type-checks
35under `tsc --checkJs` without a build step. Authentic TypeScript
36authoring works too — rename `index.js` → `index.ts`, install
37[`tsx`](https://www.npmjs.com/package/tsx), and update
38`extension.json`:
39
40```json
41{
42  "exec": "npx",
43  "args": ["-y", "tsx", "./index.ts"]
44}
45```
46
47zot doesn't care which one you use; it just spawns whatever `exec`
48points at and reads/writes JSON lines on its stdio.
49
50## See also
51
52- `examples/extensions/hello` — Go version using the `packages/agent/ext` SDK
53- `docs/extensions.md` — full protocol reference