Skip to content

mokn/cricket

Repository files navigation

Cricket

Passive QA logger for developers. Cricket silently watches your manual testing sessions and writes structured reports that AI coding assistants can act on.

You test. Cricket takes notes. Your AI fixes the bugs.

What it captures

  • Console errors & warnings — intercepted before your app code runs (sensitive data auto-redacted)
  • Network failures — 4xx, 5xx, connection errors
  • Route changes — SPA navigation and full page loads
  • Performance — LCP, CLS, long tasks
  • Screenshots — browser viewport via hotkey, or native macOS screencapture via CLI
  • Issue reports — your descriptions of what looks wrong
  • DOM context — page title, viewport size, visible modals, active element

All data stays local. Nothing leaves your machine.

Install

# 1. Clone the repo
git clone https://github.com/yourusername/cricket.git
cd cricket

# 2. Install the CLI
cd cli && npm install && npm link && cd ..

# 3. Load the extension in your browser
#    Open brave://extensions (or chrome://extensions)
#    Enable Developer mode → Load unpacked → select the cricket/ directory
#    Copy the extension ID

# 4. Set up the native messaging host
cricket setup <paste-extension-id>

# 5. Restart your browser

Usage

In the browser

  1. Click the Cricket icon or press Cmd+Shift+Q to start a session
  2. Browse your app normally — Cricket captures everything in the background
  3. Press Cmd+Shift+S to take a screenshot, type a note in the popup
  4. End the session when done

From the terminal

# Check session status
cricket status

# Take a native macOS screenshot and add it to the active session
cricket snap

# Take a screenshot with a note
cricket snap "the sidebar layout breaks at this width"

# Import a screenshot from clipboard (Cmd+Shift+4, then:)
cricket snap --clipboard

# Add a note to the last screenshot
cricket note "this should be left-aligned"

Feed to your AI assistant

# Point your AI at the session
claude
> Read the Cricket session at ~/.cricket/sessions/ and fix the issues you find

The session file is written incrementally — your AI can watch it in real-time while you test.

Output format

~/.cricket/sessions/
  2026-03-31T14-22-07/
    session.json          # Structured session data
    meta.json             # Metadata only (for fast listing)
    external.jsonl        # CLI-originated entries (screenshots, notes)
    screenshots/
      001.png
      002.png
{
  "schemaVersion": 1,
  "id": "2026-03-31T14-22-07",
  "startedAt": "2026-03-31T14:22:07.000Z",
  "endedAt": "2026-03-31T14:45:12.000Z",
  "origin": "https://your-app.com",
  "summary": {
    "consoleErrors": 3,
    "consoleWarnings": 8,
    "networkFailures": 1,
    "navigations": 12,
    "screenshots": 4,
    "issues": 1,
    "notes": 2,
    "perfEntries": 6
  },
  "entries": [
    { "seq": 1, "ts": 1743432127000, "type": "navigation", "url": "..." },
    { "seq": 2, "ts": 1743432130000, "type": "console", "level": "error", "message": "..." },
    { "seq": 5, "ts": 1743432200000, "type": "issue", "description": "Button doesn't respond", "screenshot": "screenshots/001.png" }
  ]
}

CLI Reference

Command Description
cricket status Show active session or list recent sessions
cricket snap [text] Take a screenshot (with optional note)
cricket snap --clipboard Import screenshot from clipboard
cricket snap --file <path> Import an existing screenshot file
cricket note <text> Add a text note attached to the last screenshot
cricket setup [id] Install native messaging host for your browser

Keyboard shortcuts

Shortcut Action
Cmd+Shift+Q Start/stop session
Cmd+Shift+S Capture browser screenshot

How it's different

Cricket is not LogRocket, Sentry, or FullStory. Those are cloud SaaS tools for monitoring production users. Cricket is a local developer tool for your own testing sessions.

  • Local-first — plain JSON files on disk, no accounts, no cloud, no SDK
  • AI-native — structured data optimized for LLM consumption, not dashboards
  • Passive — records in the background while you test normally
  • Private — console output is auto-sanitized (Bearer tokens, API keys, JWTs redacted)

Requirements

  • Brave, Chrome, or Edge (Chromium-based)
  • Node.js 18+
  • macOS (Linux support partial, Windows coming)

License

MIT

About

Passive QA logger for developers. Cricket watches your testing sessions and writes structured reports that AI coding assistants can act on.

Topics

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors