Quickstart

Get Beacon running locally in a few minutes.

This path gets you from clone to first trial run with the least friction.

Search docs, support, and public pages

Install

1. Start the app and workflow runtime

npm install
npm run dev
npx workflow dev

Beacon uses Next.js for the web app and the Workflow SDK for durable research execution. Both need to be available during local development.

Environment

2. Provide required credentials

Required env vars:
  GROQ_API_KEY
  SERPAPI_API_KEY
  UPSTASH_REDIS_REST_URL
  UPSTASH_REDIS_REST_TOKEN

Optional auth and agent env:
  NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY
  CLERK_SECRET_KEY
  BEACON_MCP_TOKEN
  BEACON_PASSWORD
  BEACON_SESSION_TOKEN

Open Surfaces

3. Use the right entrypoint

/trial

Public sample brief flow with framework selection and graph-backed progress/result UI.

/dashboard

Private operator surface for full research runs, memory inspection, and key management.

/docs

Public documentation hub for API, MCP, auth, security, and deployment guidance.

First Run

4. Verify the workflow path

Recommended local check:
  1. open /trial
  2. submit a sample brief
  3. confirm the run page streams from "running" to a final report
  4. rerun the same topic in /dashboard and verify memory reuse