@shadr/iterm2-ts 0.1.0 → 0.1.2

package/README.md

@@ -96,6 +96,22 @@ for await (const event of iterm.notifications("focusChanged")) {
 }
 ```
 
+### Available Events
+
+- **keystroke** — key press/release in a session (characters, modifiers, key code)
+- **screenUpdate** — screen contents changed in a session
+- **prompt** — shell prompt appeared, command started, or command ended (with exit status)
+- **customEscapeSequence** — app-defined escape sequence received (sender identity + payload)
+- **newSession** — a new session was created
+- **terminateSession** — a session was destroyed
+- **layoutChanged** — window/tab/pane layout changed (splits, reorder, resize)
+- **focusChanged** — app activation, window focus, tab selection, or session focus changed
+- **variableChanged** — a user/session/app variable changed value
+- **profileChanged** — a profile was modified
+- **broadcastDomainsChanged** — broadcast input domains changed
+- **serverOriginatedRpc** — iTerm2 invoked a registered RPC from your script
+- ~~**locationChange**~~ — hostname/username/directory changed (deprecated)
+
 ### Cleanup
 
 ```typescript
@@ -119,20 +135,20 @@ The library authenticates with iTerm2 using a cookie-based system:
 
 iTerm2 must be running with the Python API enabled.
 
-## Examples
-
-See the [`examples/`](examples/) directory:
+## CLI (`it2`)
 
-- [`list.ts`](examples/list.ts) — list all windows, tabs, sessions, and their buffer contents
-- [`activate.ts`](examples/activate.ts) — focus a window, tab, or session by ID
-- [`watch-events.ts`](examples/watch-events.ts) — subscribe to all events and log them
-
-Run any example with:
+The package includes an `it2` CLI:
 
 ```bash
-npx tsx examples/list.ts
+npx tsx src/cli.ts list                          # list sessions with process trees and buffer
+npx tsx src/cli.ts list --lines 5 --filter node  # filter by process name, limit buffer lines
+npx tsx src/cli.ts list --md                     # markdown output for LLM consumption
+npx tsx src/cli.ts watch                         # stream all events as JSON
+npx tsx src/cli.ts activate session <id>         # focus a session, tab, or window
 ```
 
+After `npm run build`, the CLI is also available as `node dist/cli.js` or via the `it2` bin.
+
 ## Documentation
 
 - [Architecture](docs/architecture.md) — layer overview and design decisions