0rrery 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,76 @@
1
+ # 0rrery
2
+
3
+ Trace-first, local-first observability for AI agent workflows. Watch what your Claude Code sessions actually did — every tool call, subagent, LLM call, and permission decision — as live traces in a local dashboard. One process, one SQLite file, no cloud.
4
+
5
+ ## Quickstart
6
+
7
+ ```
8
+ bun install -g 0rrery
9
+ 0rrery init
10
+ ```
11
+
12
+ `init` does three things (each skippable): installs Claude Code hooks (`--no-hooks`), sets up a user service so 0rrery runs persistently (`--no-service`), and imports your existing session history (`--no-import`). Then open **http://localhost:7317**.
13
+
14
+ Requires [Bun](https://bun.sh) ≥ 1.1. Claude Code hooks require the global install (the hook command is `0rrery hook`); `bunx 0rrery serve` works for a look around without installing.
15
+
16
+ ## Commands
17
+
18
+ | Command | What it does |
19
+ |---|---|
20
+ | `0rrery init` | hooks + agent skill + service + history import, idempotently |
21
+ | `0rrery serve` | run the server + dashboard in the foreground |
22
+ | `0rrery install` | (re)install Claude Code hooks into `~/.claude/settings.json`; replaces stale 0rrery entries |
23
+ | `0rrery import <file.jsonl>` | import one transcript |
24
+ | `0rrery import --all` | import everything under `~/.claude/projects` |
25
+ | `0rrery service install\|uninstall\|status` | manage the systemd user unit (Linux) / launchd agent (macOS) |
26
+
27
+ ## What gets written where
28
+
29
+ - `~/.claude/settings.json` — hook entries (command `0rrery hook`)
30
+ - `~/.0rrery/` — SQLite DB + tailer offsets
31
+ - `~/.config/systemd/user/0rrery.service` or `~/Library/LaunchAgents/com.0pon.0rrery.plist`
32
+
33
+ ## Configuration
34
+
35
+ | Env var | Default | |
36
+ |---|---|---|
37
+ | `ORRERY_PORT` | `7317` | dashboard/API port |
38
+ | `ORRERY_HOST` | `127.0.0.1` | bind address (localhost-only by design) |
39
+ | `ORRERY_DATA_DIR` | `~/.0rrery` | data directory |
40
+ | `ORRERY_DB` | `<data dir>/0rrery.db` | database path |
41
+ | `ORRERY_URL` | `http://localhost:7317` | where hooks/import post to |
42
+ | `ORRERY_CLAUDE_DIR` | `~/.claude` | Claude Code config/transcripts root |
43
+
44
+ ## Agent skill
45
+
46
+ `init` installs a skill at `~/.claude/skills/0rrery/` that teaches Claude to answer questions like "what did I spend this week", "what keeps failing in this repo", or "what did my last session do" by querying the local API. Skip with `--no-skill`; remove with `rm -rf ~/.claude/skills/0rrery`.
47
+
48
+ ## Upgrade
49
+
50
+ ```
51
+ bun install -g 0rrery@latest
52
+ 0rrery service uninstall && 0rrery service install # regenerate if the bin path changed
53
+ ```
54
+
55
+ After upgrading (or when developing from the repo), rebuild and force a reinstall so the dashboard picks up the new bundle: `bun run build:pkg`, then `bun install -g 0rrery@latest` for registry installs, or `cd ~ && bun install --force` for `file:`-pinned dev installs — an unchanged `file:` dep may skip re-copying otherwise.
56
+
57
+ ## Uninstall
58
+
59
+ ```
60
+ 0rrery service uninstall
61
+ bun remove -g 0rrery
62
+ rm -rf ~/.0rrery
63
+ ```
64
+ Hook entries: re-run a Claude session or remove entries whose command is `0rrery hook` from `~/.claude/settings.json`.
65
+
66
+ ## Development
67
+
68
+ ```
69
+ bun install
70
+ bun run build # dashboard
71
+ bun test
72
+ bun packages/cli/src/index.ts serve
73
+ bun run build:pkg # stage the npm package in dist-pkg/
74
+ ```
75
+
76
+ Specs live in `docs/superpowers/specs/`.