Skip to content

redpangilinan/crikket

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

314 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Crikket

Open-source bug reporting with the context engineers actually need.

Crikket helps teams capture bugs in one click, attach replay context automatically, and share reports with a single link.

Website Β· Documentation Β· Cloud App Β· Live Demo

GitHub Repo stars GitHub License Bun

Crikket preview

Why Crikket

Crikket is a modern, open-source alternative to tools like jam.dev and marker.io. It is built for teams that want faster bug reproduction without giving up control over their stack.

  • Capture bugs with screenshot or screen recording directly in the browser
  • Include reproduction steps, console logs, and network requests automatically
  • Share reports instantly with public or private links
  • Self-host for free or use the hosted app
  • Embed the capture widget in your own product with @crikket-io/capture

What Makes It Useful

Every report is designed to reduce the usual debugging back-and-forth.

Area What Crikket includes
Capture One-click screenshot and video bug reports
Reproduction Recorded steps to help replay what happened
Technical context Console logs and network requests attached to the report
Sharing Public or private share links per report
Collaboration Team workspaces, invites, and report management
Deployment Quick and easy self-hosting

Quick Start

Self-hosted

The fastest path from a fresh clone is the interactive setup wizard:

git clone https://github.com/redpangilinan/crikket
cd crikket
./scripts/setup.sh

The wizard handles env files, secret generation, domain prompts, Caddy setup, and Docker startup for the supported self-hosted flow.

Useful links:

Local development

For contributor setup and app-specific environment details:

bun install
cp .env.example .env
cp apps/web/.env.example apps/web/.env
cp apps/server/.env.example apps/server/.env
cp apps/docs/.env.example apps/docs/.env
cp apps/extension/.env.example apps/extension/.env

Then configure your env values, apply the database schema, and start the repo:

bun run db:push
bun run dev

Default local ports:

  • web: http://localhost:3001
  • server: http://localhost:3000
  • docs: http://localhost:4000

See CONTRIBUTING.md for the full workflow.

Embed Crikket In Your Product

Crikket ships an embeddable capture SDK for websites and web apps:

import { init } from "@crikket-io/capture"

init({
  key: "crk_your_public_key",
  host: "https://api.crikket.io",
})

That mounts the capture launcher so users can submit screenshot or screen recording bug reports without leaving your product.

Monorepo Overview

Crikket is a Bun + Turborepo monorepo.

Path Purpose
apps/web Next.js app for the product dashboard
apps/server Hono API for auth, capture, and backend workflows
apps/docs Marketing site and docs
apps/extension Browser extension app
sdks/capture Embeddable browser capture SDK
packages/* Shared internal packages

Contributing

Issues, pull requests, and feedback are welcome.

License

Licensed under the AGPL-3.0.

About

πŸ¦— Instant bug reporting and feedback tool. An open-source alternative to jam.dev and marker.io.

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Sponsor this project

 

Packages

 
 
 

Contributors