overlapdev 1.0.0 → 1.1.1
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 +29 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
# Overlap Tracer
|
|
2
2
|
|
|
3
|
+
[](https://github.com/overlapcode/overlap-tracer/actions/workflows/ci.yml)
|
|
4
|
+
[](https://github.com/overlapcode/overlap-tracer/actions/workflows/release.yml)
|
|
5
|
+
[](https://www.npmjs.com/package/overlapdev)
|
|
6
|
+
[](https://github.com/overlapcode/overlap-tracer/releases/latest)
|
|
7
|
+
[](LICENSE)
|
|
8
|
+
|
|
3
9
|
A lightweight background daemon that watches coding agent sessions (Claude Code, with more agents coming) and forwards activity signals to your team's [Overlap](https://overlap.dev) instance.
|
|
4
10
|
|
|
5
11
|
## What It Does
|
|
@@ -21,10 +27,17 @@ The tracer extracts **signals, not code**. File contents, assistant responses, a
|
|
|
21
27
|
## Install
|
|
22
28
|
|
|
23
29
|
```bash
|
|
30
|
+
# Recommended — downloads the right binary for your OS
|
|
24
31
|
curl -fsSL https://overlap.dev/install.sh | sh
|
|
25
32
|
```
|
|
26
33
|
|
|
27
|
-
Or
|
|
34
|
+
Or via npm:
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
npm install -g overlapdev
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Or download the binary directly from [GitHub Releases](https://github.com/overlapcode/overlap-tracer/releases/latest).
|
|
28
41
|
|
|
29
42
|
### Supported Platforms
|
|
30
43
|
|
|
@@ -52,6 +65,7 @@ overlap status
|
|
|
52
65
|
|
|
53
66
|
```bash
|
|
54
67
|
overlap join # Join a team (prompts for instance URL + token)
|
|
68
|
+
overlap check # Check for team overlaps (used by Claude Code hook)
|
|
55
69
|
overlap status # Show tracer status, teams, and tracked repos
|
|
56
70
|
overlap leave # Leave a team
|
|
57
71
|
overlap start # Start the tracer daemon
|
|
@@ -68,9 +82,21 @@ overlap version # Show version
|
|
|
68
82
|
|
|
69
83
|
2. **The daemon watches `~/.claude/projects/`** for JSONL session files. When you start a Claude Code session in a repo that matches your team's registered repos, the tracer starts tailing the session file.
|
|
70
84
|
|
|
71
|
-
3. **Events are extracted and batched** — session starts, file operations, prompts, and session ends are parsed from JSONL lines, batched (every 2s or 50 events), and sent to your team's Overlap instance via `POST /api/v1/ingest`.
|
|
85
|
+
3. **Events are extracted, enriched, and batched** — session starts, file operations (with line ranges and function names), prompts, and session ends are parsed from JSONL lines, batched (every 2s or 50 events), and sent to your team's Overlap instance via `POST /api/v1/ingest`.
|
|
86
|
+
|
|
87
|
+
4. **The daemon polls for team state** — every 30 seconds, the daemon fetches active sessions from your team's instance and caches them locally at `~/.overlap/team-state.json`. This powers the real-time coordination hook.
|
|
88
|
+
|
|
89
|
+
5. **The daemon survives restarts** — byte offsets are persisted to `~/.overlap/state.json`. If the daemon crashes or your machine reboots, it picks up exactly where it left off. No data lost, no duplicates.
|
|
90
|
+
|
|
91
|
+
## Real-Time Coordination
|
|
92
|
+
|
|
93
|
+
When you run `overlap join` in a project directory, the tracer sets up Claude Code hooks and commands:
|
|
94
|
+
|
|
95
|
+
- **PreToolUse hook** — before Claude Code edits a file, `overlap check` reads the local team-state cache and warns if a teammate is working on the same region. The warning includes the teammate's name, a link to their session, and their session summary.
|
|
96
|
+
- **`/project:overlap-check`** — a slash command to manually check for overlaps at any point during a session.
|
|
97
|
+
- **`/project:overlap-context`** — loads what your team is currently working on as context for the session.
|
|
72
98
|
|
|
73
|
-
|
|
99
|
+
The hook is non-blocking: if overlap isn't installed or the cache is stale, it silently exits. Safe to commit `.claude/` to your repo — teammates without overlap installed are unaffected.
|
|
74
100
|
|
|
75
101
|
## Multi-Team Support
|
|
76
102
|
|