Skip to content

docs: Update CLAUDE.md with multi-machine setup and key patterns #99

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
evansenter merged 1 commit into from
Jan 29, 2026
Merged

docs: Update CLAUDE.md with multi-machine setup and key patterns #99

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Queryable analytics for Claude Code session logs, exposed as an MCP server and CLI.

**API Reference**: `agent-session-analytics-cli --help` or `src/agent_session_analytics/guide.md` (MCP resource: `agent-session-analytics://guide`).

**Schema Design**: See [docs/SCHEMA.md](docs/SCHEMA.md) for database tables, indexes, and migration history.

**Multi-Machine Setup**: See [docs/TAILSCALE_SETUP.md](docs/TAILSCALE_SETUP.md) for deploying across machines with Tailscale.

---

## ⚠️ DATABASE PROTECTION
Expand Down Expand Up @@ -48,6 +52,9 @@ make check # fmt, lint, test
make install-server # LaunchAgent + CLI + MCP config (idempotent, restarts service)
make restart # Lightweight service restart (no dependency sync)
make logs # Tail server logs

# Run single test
uv run pytest tests/test_storage.py::TestRawEntries::test_add_raw_entries_batch -v
```

### When to Restart
Expand All @@ -63,8 +70,9 @@ make logs # Tail server logs
## Key Patterns

- **Storage API**: Use `storage.execute_query()` / `execute_write()`; avoid `_connect()`
- **Migrations**: `@migration(version, name)` decorator in storage.py
- **Migrations**: `@migration(version, name)` decorator in storage.py; update `SCHEMA_VERSION` constant
- **CLI/MCP parity**: Every query accessible from both interfaces
- **Raw entries**: `raw_entries` table stores unparsed JSONL for future re-parsing; always store alongside parsed events

---

Expand Down