@neiltron/session-visualizer 0.1.0

package/README.md

@@ -0,0 +1,92 @@
+# Session Visualizer
+
+Local filmstrip inspector for Pi session JSONL files.
+
+## Run with npx
+
+Launch against a known source root:
+
+```bash
+npx @neiltron/session-visualizer /path/to/logs
+```
+
+Launch and open the browser automatically:
+
+```bash
+npx @neiltron/session-visualizer /path/to/logs --open
+```
+
+Start without a source root and choose one in the browser:
+
+```bash
+npx @neiltron/session-visualizer
+```
+
+The CLI starts a local server, prints the URL, and binds to `127.0.0.1` by default.
+
+## Install
+
+```bash
+npm install -g @neiltron/session-visualizer
+session-visualizer /path/to/logs
+```
+
+## CLI options
+
+```text
+session-visualizer [source-root] [--open] [--port <number>]
+```
+
+- `source-root` — optional directory containing Pi session JSONL files
+- `--open` — open the default browser after startup
+- `--port <number>` — override the default local server port (`4174`)
+
+## Features
+
+- Recursive discovery of Pi session JSONL files
+- Session list sorted newest-first with duration, tool, and error stats
+- Five-lane filmstrip timeline: metadata, user, assistant, tools, custom
+- Tool call/result pairing
+- Parsed summary and raw JSON inspector
+
+## Deep Links
+
+Link to a specific session by relative path:
+
+```text
+/?path=tasks/task_abc/pi-sessions/session.jsonl
+```
+
+## Local development
+
+All contributor commands run from the repository root.
+
+Install dependencies:
+
+```bash
+bun install
+```
+
+Start the development servers:
+
+```bash
+bun run dev
+```
+
+Open an explicit source root at startup:
+
+```bash
+DATA_DIR=/path/to/logs bun run dev
+```
+
+## Build and test
+
+```bash
+bun run test
+bun run build
+bun run smoke:package
+```
+
+## Release
+
+Maintainer release steps live in `docs/releasing.md`.