Skip to content

Repository files navigation

FlarePeek

English | 简体中文

Chrome Web Store

A Chrome extension for Cloudflare Workers developers. Once you're signed in with your Cloudflare account and open a zone hostname served by a Worker, FlarePeek automatically identifies the Worker and gives you development tools right there — for example, temporarily routing a production hostname's traffic to a specific preview version (built on Version Overrides), inspecting gradual-deployment status, and viewing Worker request/error metrics.

Documentation

Authentication

Cloudflare doesn't offer a public OAuth client registration flow for third-party apps (the OAuth wrangler login uses is an internal Cloudflare-only client). Because of that, this extension signs in with a scoped API token instead: the extension links out to the Cloudflare Dashboard with a permission template pre-filled, the user creates a minimal-permission API token there, and pastes it back into the extension to store.

Development

pnpm install       # Install dependencies
pnpm dev           # Start the dev server (Chrome, with HMR)
pnpm dev:firefox   # Start the dev server (Firefox)

pnpm compile       # TypeScript type-check
pnpm lint          # ESLint check
pnpm lint:fix      # ESLint autofix
pnpm format        # Prettier format
pnpm format:check  # Check formatting only, don't write

pnpm test          # Vitest unit tests
pnpm test:watch    # Vitest watch mode
pnpm build         # Build the production bundle to .output/chrome-mv3
pnpm test:e2e      # Playwright e2e (needs pnpm build to have produced .output/chrome-mv3 first)

pnpm zip           # Package a zip ready to upload to the Chrome Web Store

To load it into Chrome for the first time: run pnpm build, then open chrome://extensions, enable Developer mode → Load unpacked → select .output/chrome-mv3.

Skip re-pasting an API token on every reload: copy .env.example to .env.development.local and set WXT_DEV_CF_API_TOKENS to one or more comma-separated Cloudflare API tokens (handy for testing multi-account/token-switching too). In dev builds only, and only when the extension's storage has no token saved yet, these are verified and seeded in automatically — see entrypoints/background/dev-token-seed.ts. .env.development.local is gitignored and, being mode-scoped, is never loaded by pnpm build/pnpm zip, so nothing in it ends up in a shipped build.

Contributing

Contributions are welcome. Please read AGENTS.md for the project's coding conventions before opening a PR — CI runs pnpm format:check, pnpm lint, pnpm compile, pnpm test, and pnpm build on every pull request.

License

MIT

About

A Chrome extension for Cloudflare Workers developers

Resources

Stars

0 stars

Watchers

0 watching

Forks

Contributors

Languages