Skip to main content

Make any repo agent-ready. Instantly.

Beacon scans your codebase, infers its agent-usable capabilities using AI, and generates a standards-compliant AGENTS.md file making your repo discoverable by any autonomous agent.

Get StartedAPI Reference

Quick start

Get Beacon up and running in minutes with these simple steps

1

Install Beacon

Install Beacon using the install script or Docker:
curl -fsSL https://raw.githubusercontent.com/DavidNzube101/beacon/master/install.sh | sh
2

Set your AI provider key

Beacon supports multiple AI providers. Set your preferred provider’s API key:
export GEMINI_API_KEY=your_key_here
  • Gemini 2.5 Flash (default) - GEMINI_API_KEY
  • Claude - CLAUDE_API_KEY
  • OpenAI GPT-4o - OPENAI_API_KEY
  • Beacon Cloud - No key needed, pay per run via USDC
3

Generate your AGENTS.md file

Point Beacon at your repository and generate an AGENTS.md file:
beacon generate ./my-project
You can also specify a different provider:
beacon generate ./my-project --provider claude --api-key sk-ant-...
4

Validate your AGENTS.md

Ensure your generated file is valid and check endpoint reachability:
beacon validate ./AGENTS.md --check-endpoints
The --check-endpoints flag tests if any declared endpoints in your AGENTS.md are actually reachable.

Explore by topic

Learn how to use Beacon’s powerful features

Core Concepts

Understand AGENTS.md format and how Beacon works

CLI Commands

Master Beacon’s command-line interface

AI Providers

Choose the right AI provider for your needs

API Reference

Integrate Beacon programmatically via REST API

Docker Deployment

Deploy Beacon as a containerized service

Blockchain Identity

Register agent identities on-chain

Key features

Everything you need to make your repositories agent-ready

AI-Powered Analysis

Automatically infers capabilities, endpoints, and authentication from your codebase using advanced AI models

Standards-Compliant

Generates AGENTS.md files following the official AAIF specification for maximum compatibility

Multiple AI Providers

Choose from Gemini, Claude, OpenAI, or Beacon Cloud with flexible pricing options

REST API & CLI

Use Beacon as a command-line tool or integrate it programmatically via REST API

Blockchain Integration

Register agent identities on-chain and verify payments via USDC on Base and Solana

Built-in Validation

Validate AGENTS.md structure and test endpoint reachability before deployment

Ready to make your repos agent-ready?

Get started with Beacon today and enable AI agents to discover and interact with your repositories automatically.

Get StartedView on GitHub