runtape 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/LICENSE +21 -0
- package/README.md +68 -0
- package/bin/runtape.js +2 -0
- package/dist/chunk-Q4RSBPGN.js +81 -0
- package/dist/chunk-Q4RSBPGN.js.map +1 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +756 -0
- package/dist/index.js.map +1 -0
- package/dist/types.d.ts +863 -0
- package/dist/types.js +23 -0
- package/dist/types.js.map +1 -0
- package/package.json +52 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Alfredo Izquierdo
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
# Runtape CLI
|
|
2
|
+
|
|
3
|
+
> Flight recorder for AI coding agents. Replay every run, find every bug.
|
|
4
|
+
|
|
5
|
+
`runtape` is the open-source CLI for [Runtape](https://runtape.dev) — observability and replay for AI coding agents like Claude Code.
|
|
6
|
+
|
|
7
|
+
## Status
|
|
8
|
+
|
|
9
|
+
v0.1 — MVP. The CLI captures Claude Code sessions via hooks and streams them to a Runtape backend.
|
|
10
|
+
|
|
11
|
+
## Install
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install -g runtape
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
(Requires Node.js ≥ 20.)
|
|
18
|
+
|
|
19
|
+
## Get started
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
runtape login # paste the API key from your runtape.dev dashboard
|
|
23
|
+
runtape install # add hooks to ~/.claude/settings.json
|
|
24
|
+
# …run Claude Code normally…
|
|
25
|
+
runtape runs # open your dashboard in the browser
|
|
26
|
+
runtape status # buffer state, server reachability, flusher PID
|
|
27
|
+
runtape uninstall # remove the hooks when you're done
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## How it works
|
|
31
|
+
|
|
32
|
+
`runtape install` adds entries to `~/.claude/settings.json` so that Claude Code fires `runtape push --event <HookName>` on every relevant hook event. When installed under any `node_modules` tree (npm-global, pnpm-workspace, etc.), the entry uses the bare command name `runtape` so it survives package upgrades; when run from source (e.g. `tsx bin/runtape.ts` during local development) it uses the absolute path from `process.argv[1]`. Override with the `RUNTAPE_CLI_BIN` env var if you need a specific path. Each invocation appends one validated JSON line to `~/.runtape/buffer/<session_id>.ndjson` (sub-10ms) and lazily spawns a detached flusher daemon. The daemon batches events (up to 100 per POST) and ships them to the backend with exponential backoff on transient failures. It exits after 30s of idle.
|
|
33
|
+
|
|
34
|
+
## State on disk
|
|
35
|
+
|
|
36
|
+
```
|
|
37
|
+
~/.runtape/
|
|
38
|
+
config.json # api_key (chmod 600), server_url
|
|
39
|
+
buffer/<session_id>.ndjson # pending events
|
|
40
|
+
seq/<session_id> # monotonic sequence counter
|
|
41
|
+
flusher.pid # daemon PID
|
|
42
|
+
flusher.log # daemon log (append-only)
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Override the home dir with `RUNTAPE_HOME` (useful for tests). Override the server with `RUNTAPE_API_URL` or `runtape login --server-url <url>`.
|
|
46
|
+
|
|
47
|
+
## Subpath exports
|
|
48
|
+
|
|
49
|
+
Backend services that ingest Runtape events can import the shared Zod schemas:
|
|
50
|
+
|
|
51
|
+
```ts
|
|
52
|
+
import { RuntapeEvent, IngestionRequest } from "runtape/types";
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
The schemas live in `src/types.ts`. The package's `exports` map points TypeScript at the source file (no build step required for type consumers) and Node at the compiled `dist/types.js`.
|
|
56
|
+
|
|
57
|
+
## Open source
|
|
58
|
+
|
|
59
|
+
MIT licensed. Audit exactly what's captured. The Runtape backend (dashboard, ingestion API) is closed-source SaaS at [runtape.dev](https://runtape.dev).
|
|
60
|
+
|
|
61
|
+
## Repos
|
|
62
|
+
|
|
63
|
+
- This repo (`runtape`) — the open-source CLI
|
|
64
|
+
- `runtape-mcp` — MCP server for Runtape (coming v0.2)
|
|
65
|
+
|
|
66
|
+
## License
|
|
67
|
+
|
|
68
|
+
[MIT](./LICENSE)
|
package/bin/runtape.js
ADDED
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
// src/types.ts
|
|
2
|
+
import { z } from "zod";
|
|
3
|
+
var ClaudeHookBase = z.object({
|
|
4
|
+
session_id: z.string().min(1),
|
|
5
|
+
transcript_path: z.string().min(1),
|
|
6
|
+
cwd: z.string().min(1),
|
|
7
|
+
hook_event_name: z.string().min(1),
|
|
8
|
+
permission_mode: z.string().optional()
|
|
9
|
+
});
|
|
10
|
+
var CliAugment = z.object({
|
|
11
|
+
wall_ts: z.string().datetime(),
|
|
12
|
+
sequence: z.number().int().nonnegative()
|
|
13
|
+
});
|
|
14
|
+
var SessionStartEvent = ClaudeHookBase.extend(CliAugment.shape).extend({
|
|
15
|
+
type: z.literal("session_start"),
|
|
16
|
+
source: z.string()
|
|
17
|
+
});
|
|
18
|
+
var UserPromptEvent = ClaudeHookBase.extend(CliAugment.shape).extend({
|
|
19
|
+
type: z.literal("user_prompt"),
|
|
20
|
+
prompt: z.string()
|
|
21
|
+
});
|
|
22
|
+
var ToolAttemptEvent = ClaudeHookBase.extend(CliAugment.shape).extend({
|
|
23
|
+
type: z.literal("tool_attempt"),
|
|
24
|
+
tool_name: z.string().min(1),
|
|
25
|
+
tool_input: z.unknown(),
|
|
26
|
+
tool_use_id: z.string().min(1)
|
|
27
|
+
});
|
|
28
|
+
var ToolCallEvent = ClaudeHookBase.extend(CliAugment.shape).extend({
|
|
29
|
+
type: z.literal("tool_call"),
|
|
30
|
+
tool_name: z.string().min(1),
|
|
31
|
+
tool_input: z.unknown(),
|
|
32
|
+
tool_response: z.unknown(),
|
|
33
|
+
tool_use_id: z.string().min(1),
|
|
34
|
+
duration_ms: z.number().nonnegative()
|
|
35
|
+
});
|
|
36
|
+
var SubagentEndEvent = ClaudeHookBase.extend(CliAugment.shape).extend({
|
|
37
|
+
type: z.literal("subagent_end"),
|
|
38
|
+
agent_id: z.string().min(1),
|
|
39
|
+
agent_type: z.string().min(1),
|
|
40
|
+
agent_transcript_path: z.string().min(1),
|
|
41
|
+
last_assistant_message: z.string(),
|
|
42
|
+
stop_hook_active: z.boolean().optional()
|
|
43
|
+
});
|
|
44
|
+
var SessionEndEvent = ClaudeHookBase.extend(CliAugment.shape).extend({
|
|
45
|
+
type: z.literal("session_end"),
|
|
46
|
+
last_assistant_message: z.string().optional(),
|
|
47
|
+
stop_hook_active: z.boolean().optional()
|
|
48
|
+
});
|
|
49
|
+
var RuntapeEvent = z.discriminatedUnion("type", [
|
|
50
|
+
SessionStartEvent,
|
|
51
|
+
UserPromptEvent,
|
|
52
|
+
ToolAttemptEvent,
|
|
53
|
+
ToolCallEvent,
|
|
54
|
+
SubagentEndEvent,
|
|
55
|
+
SessionEndEvent
|
|
56
|
+
]);
|
|
57
|
+
var IngestionRequest = z.object({
|
|
58
|
+
events: z.array(RuntapeEvent).min(1).max(100)
|
|
59
|
+
});
|
|
60
|
+
var IngestionResponse = z.object({
|
|
61
|
+
accepted: z.number().int().nonnegative(),
|
|
62
|
+
errors: z.array(
|
|
63
|
+
z.object({
|
|
64
|
+
index: z.number().int().nonnegative(),
|
|
65
|
+
reason: z.string()
|
|
66
|
+
})
|
|
67
|
+
).default([])
|
|
68
|
+
});
|
|
69
|
+
|
|
70
|
+
export {
|
|
71
|
+
SessionStartEvent,
|
|
72
|
+
UserPromptEvent,
|
|
73
|
+
ToolAttemptEvent,
|
|
74
|
+
ToolCallEvent,
|
|
75
|
+
SubagentEndEvent,
|
|
76
|
+
SessionEndEvent,
|
|
77
|
+
RuntapeEvent,
|
|
78
|
+
IngestionRequest,
|
|
79
|
+
IngestionResponse
|
|
80
|
+
};
|
|
81
|
+
//# sourceMappingURL=chunk-Q4RSBPGN.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/types.ts"],"sourcesContent":["import { z } from 'zod';\n\n// Every Claude Code hook event carries these envelope fields.\nconst ClaudeHookBase = z.object({\n session_id: z.string().min(1),\n transcript_path: z.string().min(1),\n cwd: z.string().min(1),\n hook_event_name: z.string().min(1),\n permission_mode: z.string().optional(),\n});\n\n// CLI-augmented envelope adds monotonic ordering + wall-clock timestamp.\nconst CliAugment = z.object({\n wall_ts: z.string().datetime(),\n sequence: z.number().int().nonnegative(),\n});\n\nexport const SessionStartEvent = ClaudeHookBase.extend(CliAugment.shape).extend({\n type: z.literal('session_start'),\n source: z.string(),\n});\n\nexport const UserPromptEvent = ClaudeHookBase.extend(CliAugment.shape).extend({\n type: z.literal('user_prompt'),\n prompt: z.string(),\n});\n\nexport const ToolAttemptEvent = ClaudeHookBase.extend(CliAugment.shape).extend({\n type: z.literal('tool_attempt'),\n tool_name: z.string().min(1),\n tool_input: z.unknown(),\n tool_use_id: z.string().min(1),\n});\n\nexport const ToolCallEvent = ClaudeHookBase.extend(CliAugment.shape).extend({\n type: z.literal('tool_call'),\n tool_name: z.string().min(1),\n tool_input: z.unknown(),\n tool_response: z.unknown(),\n tool_use_id: z.string().min(1),\n duration_ms: z.number().nonnegative(),\n});\n\nexport const SubagentEndEvent = ClaudeHookBase.extend(CliAugment.shape).extend({\n type: z.literal('subagent_end'),\n agent_id: z.string().min(1),\n agent_type: z.string().min(1),\n agent_transcript_path: z.string().min(1),\n last_assistant_message: z.string(),\n stop_hook_active: z.boolean().optional(),\n});\n\nexport const SessionEndEvent = ClaudeHookBase.extend(CliAugment.shape).extend({\n type: z.literal('session_end'),\n last_assistant_message: z.string().optional(),\n stop_hook_active: z.boolean().optional(),\n});\n\nexport const RuntapeEvent = z.discriminatedUnion('type', [\n SessionStartEvent,\n UserPromptEvent,\n ToolAttemptEvent,\n ToolCallEvent,\n SubagentEndEvent,\n SessionEndEvent,\n]);\n\nexport type RuntapeEvent = z.infer<typeof RuntapeEvent>;\n\n// POST /v1/events body — a batch of up to 100 events.\nexport const IngestionRequest = z.object({\n events: z.array(RuntapeEvent).min(1).max(100),\n});\n\nexport type IngestionRequest = z.infer<typeof IngestionRequest>;\n\n// Response shape (server returns 200 on accepted, 400 on Zod failure, 401 on bad auth).\nexport const IngestionResponse = z.object({\n accepted: z.number().int().nonnegative(),\n errors: z\n .array(\n z.object({\n index: z.number().int().nonnegative(),\n reason: z.string(),\n }),\n )\n .default([]),\n});\n\nexport type IngestionResponse = z.infer<typeof IngestionResponse>;\n"],"mappings":";AAAA,SAAS,SAAS;AAGlB,IAAM,iBAAiB,EAAE,OAAO;AAAA,EAC9B,YAAY,EAAE,OAAO,EAAE,IAAI,CAAC;AAAA,EAC5B,iBAAiB,EAAE,OAAO,EAAE,IAAI,CAAC;AAAA,EACjC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC;AAAA,EACrB,iBAAiB,EAAE,OAAO,EAAE,IAAI,CAAC;AAAA,EACjC,iBAAiB,EAAE,OAAO,EAAE,SAAS;AACvC,CAAC;AAGD,IAAM,aAAa,EAAE,OAAO;AAAA,EAC1B,SAAS,EAAE,OAAO,EAAE,SAAS;AAAA,EAC7B,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY;AACzC,CAAC;AAEM,IAAM,oBAAoB,eAAe,OAAO,WAAW,KAAK,EAAE,OAAO;AAAA,EAC9E,MAAM,EAAE,QAAQ,eAAe;AAAA,EAC/B,QAAQ,EAAE,OAAO;AACnB,CAAC;AAEM,IAAM,kBAAkB,eAAe,OAAO,WAAW,KAAK,EAAE,OAAO;AAAA,EAC5E,MAAM,EAAE,QAAQ,aAAa;AAAA,EAC7B,QAAQ,EAAE,OAAO;AACnB,CAAC;AAEM,IAAM,mBAAmB,eAAe,OAAO,WAAW,KAAK,EAAE,OAAO;AAAA,EAC7E,MAAM,EAAE,QAAQ,cAAc;AAAA,EAC9B,WAAW,EAAE,OAAO,EAAE,IAAI,CAAC;AAAA,EAC3B,YAAY,EAAE,QAAQ;AAAA,EACtB,aAAa,EAAE,OAAO,EAAE,IAAI,CAAC;AAC/B,CAAC;AAEM,IAAM,gBAAgB,eAAe,OAAO,WAAW,KAAK,EAAE,OAAO;AAAA,EAC1E,MAAM,EAAE,QAAQ,WAAW;AAAA,EAC3B,WAAW,EAAE,OAAO,EAAE,IAAI,CAAC;AAAA,EAC3B,YAAY,EAAE,QAAQ;AAAA,EACtB,eAAe,EAAE,QAAQ;AAAA,EACzB,aAAa,EAAE,OAAO,EAAE,IAAI,CAAC;AAAA,EAC7B,aAAa,EAAE,OAAO,EAAE,YAAY;AACtC,CAAC;AAEM,IAAM,mBAAmB,eAAe,OAAO,WAAW,KAAK,EAAE,OAAO;AAAA,EAC7E,MAAM,EAAE,QAAQ,cAAc;AAAA,EAC9B,UAAU,EAAE,OAAO,EAAE,IAAI,CAAC;AAAA,EAC1B,YAAY,EAAE,OAAO,EAAE,IAAI,CAAC;AAAA,EAC5B,uBAAuB,EAAE,OAAO,EAAE,IAAI,CAAC;AAAA,EACvC,wBAAwB,EAAE,OAAO;AAAA,EACjC,kBAAkB,EAAE,QAAQ,EAAE,SAAS;AACzC,CAAC;AAEM,IAAM,kBAAkB,eAAe,OAAO,WAAW,KAAK,EAAE,OAAO;AAAA,EAC5E,MAAM,EAAE,QAAQ,aAAa;AAAA,EAC7B,wBAAwB,EAAE,OAAO,EAAE,SAAS;AAAA,EAC5C,kBAAkB,EAAE,QAAQ,EAAE,SAAS;AACzC,CAAC;AAEM,IAAM,eAAe,EAAE,mBAAmB,QAAQ;AAAA,EACvD;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,CAAC;AAKM,IAAM,mBAAmB,EAAE,OAAO;AAAA,EACvC,QAAQ,EAAE,MAAM,YAAY,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG;AAC9C,CAAC;AAKM,IAAM,oBAAoB,EAAE,OAAO;AAAA,EACxC,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY;AAAA,EACvC,QAAQ,EACL;AAAA,IACC,EAAE,OAAO;AAAA,MACP,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY;AAAA,MACpC,QAAQ,EAAE,OAAO;AAAA,IACnB,CAAC;AAAA,EACH,EACC,QAAQ,CAAC,CAAC;AACf,CAAC;","names":[]}
|
package/dist/index.d.ts
ADDED