> 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

Install the GitHub App, map a repository and add Pharaoh to supported local coding agents with npx, or connect over HTTPS.

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

1. [Install the GitHub App](https://pharaoh.so/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 repository to finish mapping.
3. For local developer clients, run `npx @pharaoh-so/mcp@latest install`. It signs you in and reports setup for supported Claude Code, Codex and Claude Desktop installations. Follow each client's restart or trust instructions. You can also connect [Claude Chat](https://pharaoh.so/docs/connect/claude-ai.md) or another client with the HTTPS server URL.
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.

## Follow setup progress

The [setup page](https://mcp.pharaoh.so/setup) tracks four steps:

* **Install Pharaoh on GitHub** names each account or organization where the app is installed.
* **Map a repo** shows your repositories' state: queued, mapping with progress, or mapped with its function count. A first map takes about 1 to 5 minutes for most repositories and up to 15 minutes for large ones.
* **Connect your agent** reads “Waiting for your first connection” until your client signs in, then “Connected”. After your first question, it shows when the last one was asked, such as “Last question just now”.
* **Add the Pharaoh instruction** appears once an agent you added by the server URL connects, and offers the line to copy into your agent's instructions. The installer asks once before adding it to global `CLAUDE.md` for Claude Code and the effective global Codex file under `CODEX_HOME` or `~/.codex/`, preferring a nonempty `AGENTS.override.md` to `AGENTS.md`. You can dismiss this step, and setup completes without it.

## What your agent can ask

Once a repository is mapped, your agent can request the codebase map (modules, dependencies, entry points and frequently changed files), a module's exports and callers, a function search across the repository, the blast radius of a change, and code that no entry point reaches. The [tool reference](https://pharaoh.so/docs/use-pharaoh/overview.md) lists each tool. Pharaoh maps TypeScript, JavaScript, Python, C and C++.

## Scope

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

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