> For the complete documentation index, see [llms.txt](https://pharaoh.so/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://pharaoh.so/docs/readme.md).

# Get started

Pharaoh gives your AI client a searchable map of your GitHub repositories: modules, functions, dependencies and detected call paths.

1. [Install the GitHub App](/docs/connect/github-app.md) on the account that owns your code. Choose the repositories Pharaoh may read.
2. Open [setup](https://mcp.pharaoh.so/setup) and wait for a live repository to finish mapping.
3. Connect [Claude Code](/docs/connect/claude-code.md), [Claude Chat](/docs/connect/claude-ai.md), or another remote MCP client.
4. Ask: “Use Pharaoh to show the codebase map for owner/repo, including when it was last refreshed.” Replace owner/repo with your repository.

A successful query confirms that your client can use Pharaoh. The setup page shows mapping and connection status for your account.

Pharaoh maps pushed code on the default branch. It does not see uncommitted changes, worktrees or unmerged branches through this map. Read [scope and troubleshooting](/docs/use-pharaoh/troubleshooting.md) before using an analysis result to make a code change.

[Tool reference](/docs/use-pharaoh/overview.md) · [Security](/docs/use-pharaoh/security.md) · [Account and billing](/docs/use-pharaoh/pricing.md)