https://github.com/redpangilinan/crikket
🦗 Instant bug reporting and feedback tool. An open-source alternative to jam.dev and marker.io.
https://github.com/redpangilinan/crikket
better-auth bug-report bug-reporting bugreport extension-chrome monorepo nextjs open-source sdk sdk-js sdk-typescript self-hosted selfhosted shadcn-ui
Last synced: 2 months ago
JSON representation
🦗 Instant bug reporting and feedback tool. An open-source alternative to jam.dev and marker.io.
- Host: GitHub
- URL: https://github.com/redpangilinan/crikket
- Owner: redpangilinan
- License: agpl-3.0
- Created: 2026-02-03T22:19:49.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2026-03-19T12:22:43.000Z (3 months ago)
- Last Synced: 2026-03-20T05:32:59.483Z (3 months ago)
- Topics: better-auth, bug-report, bug-reporting, bugreport, extension-chrome, monorepo, nextjs, open-source, sdk, sdk-js, sdk-typescript, self-hosted, selfhosted, shadcn-ui
- Language: TypeScript
- Homepage: https://crikket.io
- Size: 2.63 MB
- Stars: 59
- Watchers: 1
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
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
## 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:
```bash
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:
- [Self-hosting quick start](https://crikket.io/docs/self-hosting/quick-start)
- [Production deployment guide](https://crikket.io/docs/self-hosting/production)
- [Self-hosting troubleshooting](https://crikket.io/docs/self-hosting/troubleshooting)
### Local development
For contributor setup and app-specific environment details:
```bash
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:
```bash
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](./CONTRIBUTING.md) for the full workflow.
## Embed Crikket In Your Product
Crikket ships an embeddable capture SDK for websites and web apps:
```ts
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.
- [Capture SDK README](./sdks/capture/README.md)
- [Capture quick start docs](https://crikket.io/docs/usage/quick-start)
## 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.
- [Contributing guide](./CONTRIBUTING.md)
- [Security policy](./SECURITY.md)
## License
Licensed under the [AGPL-3.0](./LICENSE).