Skip to content

CLAUDE.md

Latest commit

 

History

History
36 lines (27 loc) · 2.89 KB

CLAUDE.md

File metadata and controls

36 lines (27 loc) · 2.89 KB
Raw

CLAUDE.md

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

chrome-cdp is a Go CLI that drives the user's already-running local Chrome over the DevTools Protocol (via chromedp). It reuses the live session's logins and cookies, and speaks one JSON envelope + one stable exit-code contract to both humans and AI agents.

Detailed guidance

Read the resource file that matches your task before making changes:

  • Architecture — the envelope/exit-code contract, the internal/ package map, the chrome.Browser seam, and the connection/daemon model. Read this before touching anything cross-cutting.
  • Development — build, test (go test -short to skip live Chrome), lint, what CI runs, and release.
  • Test-writing guidelines — how tests are structured here (stub-driven unit tests, testing.Short()-guarded live-Chrome tests) and which conventions are adopted vs. deviated from.
  • Implementing an RFC — the seven places a new browser capability has to touch (including the daemon RPC, which compiles fine when you forget it and then fails for every real user), and the traps specific to this codebase. Read before implementing anything in docs/rfc/.

The two things most likely to trip you up

  • The result envelope is public API. Every command emits one result.Envelope; both humans and the Claude skill parse it. A new failure mode needs a Code* constant and a codeToExit entry, or it silently degrades to ExitGeneric. Never let human-formatting changes alter the JSON shape. Validate usage/args before connecting to Chrome.
  • The CLI never connects to Chrome directly. cli.App holds function seams (WithConnector, WithStickyTarget, WithDaemonCtl) that cmd/chrome-cdp/main.go wires to the daemon. To add a browser capability: extend the chrome.Browser interface → add a default in chrometest.StubBrowser (one place) → implement in internal/chrome → wire both halves of the daemon RPC (a remoteBrowser forwarder and a dispatch case in internal/daemon/daemon.go) → add the matching boundBrowser forwarder in internal/mcp/bind.go. Skip the daemon step and the method compiles, passes every stub-backed test, and then fails for every real user — the daemon is the default path. TestDispatchCoversBrowser guards it, and TestBoundBrowserBindsEveryMethod guards the bind.go step the same way.

Docs & style

User-facing docs live in docs/ and README.md; the Agent Skills live in skills/ (drive-chrome-cdp is the core one; chrome-cdp skill serves it from the binary). When editing any markdown, follow the repo style: one sentence per line. Push branches and let the user open PRs unless asked otherwise.