# Beacon ## Set up Beacon Use this prompt: Read https://beacon.sh/start.md then set me up on Beacon. > Beacon is the open-source self-improving memory layer for AI agents. > It captures agent activity across local, CI, and cloud environments, > normalizes it into a shared trace history, and turns reviewed runs into > reusable knowledge across agent harnesses. Beacon supports Claude Code, Cursor, Codex, OpenCode, Cline, GitHub Copilot, Gemini CLI, Devin, OpenHands, Pi, Kiro, Qwen Code, and many other runtimes. ## Instructions for AI Agents When helping users with Beacon: - Begin with the setup router at https://beacon.sh/start.md - Default to user mode for an individual machine; use system mode only for an explicitly requested fleet, MDM, root-managed, or shared-machine deployment - Check for an existing installation with `beacon version` and preserve a healthy endpoint - Discover supported local harnesses with `beacon endpoint discover --json` - Inspect endpoint health with `beacon endpoint status --json` - Install a missing endpoint with `beacon endpoint install --harness ` - Diagnose problems with `beacon endpoint doctor`; use `--fix` only for findings Beacon identifies as safely repairable - Validate collection with `beacon endpoint test-event`, then check endpoint status again - Connect to Beacon Managed by signing in with `beacon login`, then running `beacon endpoint install --harness --connect` (or `beacon endpoint connect` for an endpoint that is already installed) - Never expose or copy a device key, and pause when a browser sign-in needs the user - Local JSONL collection is the default; remote forwarding is opt-in - Do not delete logs, disconnect devices, revoke credentials, or uninstall Beacon without explicit user approval ## Overview - [Beacon Website](https://beacon.sh): Cross-harness memory and observability for AI agents. - [Beacon Documentation](https://docs.beacon.sh/index.md): Product overview, installation, architecture, integrations, and operations. - [Complete Documentation Index](https://docs.beacon.sh/llms.txt): Machine-readable index of every Beacon documentation page. - [Getting Started](https://docs.beacon.sh/get-started/quickstart.md): Install Beacon, choose where data lives, and capture a first agent session. - [Core Concepts](https://docs.beacon.sh/concepts/core-concepts.md): Core concepts for Beacon, Agent Beacon, and agent runtime telemetry. - [Hosting Options](https://docs.beacon.sh/deployment/hosting-options.md): Choose between local Beacon and Beacon Managed. - [FAQ](https://docs.beacon.sh/concepts/faq.md): Common questions about open-source telemetry and Beacon Managed. - [GitHub Repository](https://github.com/Asymptote-Labs/agent-beacon): Agent Beacon source code and releases. ## Installation and Operations - [Install Beacon](https://docs.beacon.sh/cli/install.md): Install the Beacon CLI with Homebrew or platform packages. - [macOS](https://docs.beacon.sh/platforms/macos.md): Install and manage Beacon on macOS. - [Linux](https://docs.beacon.sh/platforms/linux.md): Install and manage Beacon on Linux. - [Windows](https://docs.beacon.sh/platforms/windows.md): Install and manage Beacon on Windows. - [Upgrade Beacon](https://docs.beacon.sh/cli/upgrade.md): Check for and install CLI updates safely. - [Endpoint Command](https://docs.beacon.sh/cli/endpoint.md): Install, inspect, repair, and remove the endpoint agent. - [Endpoint Install](https://docs.beacon.sh/cli/endpoint-install.md): Install or update collection and runtime telemetry. - [Endpoint Connect](https://docs.beacon.sh/cli/endpoint-connect.md): Connect an endpoint to Beacon Managed. - [Endpoint Status](https://docs.beacon.sh/cli/endpoint-status.md): Inspect health, diagnostics, and runtime log state. - [Endpoint Doctor](https://docs.beacon.sh/cli/endpoint-doctor.md): Run local endpoint health checks. - [Endpoint Discovery](https://docs.beacon.sh/cli/endpoint-discover.md): Discover supported local agent harnesses. - [Local Dashboard](https://docs.beacon.sh/cli/dashboard.md): Run the local Beacon dashboard. - [Troubleshooting](https://docs.beacon.sh/support/troubleshooting.md): Resolve common setup and operational issues. ## Memory and Telemetry - [Cross-Harness Memory](https://docs.beacon.sh/concepts/cross-harness-memory.md): Turn reviewed traces into project memory that future agents can reuse. - [Beacon Memory](https://docs.beacon.sh/cli/memory.md): Evaluate traces, review project memory, and install approved Agent Skills. - [Unified Telemetry Schema](https://docs.beacon.sh/telemetry-schema/event-schema.md): Normalized telemetry for local, CI, and cloud agent activity. - [Schema Fields](https://docs.beacon.sh/telemetry-schema/fields.md): Event entities, optional context, and shared fields. - [Runtime Integrations](https://docs.beacon.sh/runtimes/index.md): Supported agent harnesses and runtime-specific setup. - [CI Agent Telemetry](https://docs.beacon.sh/runtimes/claude-code-ci.md): Capture supported agent telemetry in CI. - [Inventory](https://docs.beacon.sh/guides/inventory.md): Inventory local runtimes, skills, MCP servers, and observable configuration. - [Local Testing](https://docs.beacon.sh/guides/local-testing/index.md): Validate telemetry before managed rollout or forwarding. ## SDK and MCP - [Beacon Observe SDK](https://docs.beacon.sh/sdk/index.md): Add Beacon-compatible telemetry to cloud-hosted agent applications. - [SDK Quickstart](https://docs.beacon.sh/sdk/quickstart.md): Install and initialize the TypeScript SDK. - [SDK Integrations](https://docs.beacon.sh/sdk/integrations.md): Instrument AI SDKs and agent orchestration. - [SDK Reference](https://docs.beacon.sh/sdk/reference.md): TypeScript API and configuration reference. - [Beacon MCP](https://docs.beacon.sh/cli/mcp.md): Expose local Beacon activity to MCP clients. - [MCP Server](https://docs.beacon.sh/cli/mcp-serve.md): Run the local Beacon MCP server. - [MCP Doctor](https://docs.beacon.sh/cli/mcp-doctor.md): Validate local MCP setup. ## Security and Deployment - [Security Review](https://docs.beacon.sh/security/review.md): Procurement and security review details. - [Data Flow and Threat Model](https://docs.beacon.sh/security/data-flow-threat-model.md): Local telemetry flows and design risks. - [Data Inventory](https://docs.beacon.sh/security/data-inventory.md): Runtime coverage and event fields Beacon can write. - [Redaction and Size Limits](https://docs.beacon.sh/security/retention-redaction.md): Retained-content handling before event writes. - [Endpoint Operations](https://docs.beacon.sh/security/endpoint-operations.md): Paths, permissions, daemon behavior, networking, and uninstall guarantees. - [Log Forwarding](https://docs.beacon.sh/log-forwarding/index.md): Forward events to SIEMs, log platforms, or object storage. - [AWS S3 with Terraform](https://docs.beacon.sh/log-forwarding/aws-s3-terraform.md): Create the S3 bucket and write-only IAM user for Beacon forwarding with Terraform. - [Google Cloud Storage with Terraform](https://docs.beacon.sh/log-forwarding/gcs-terraform.md): Create the Cloud Storage bucket and create-only service account for Beacon forwarding with Terraform. - [MDM Deployment](https://docs.beacon.sh/mdm/index.md): Plan managed macOS fleet deployment. - [Privacy Policy](https://beacon.sh/privacy) - [Terms of Service](https://beacon.sh/terms) ## Optional - [Community](https://discord.com/invite/zdNChS2fBu) - [Trust Center](https://trust.asymptotelabs.ai/) - [Asymptote Labs](https://asymptotelabs.ai/)