# Codebase

Publish architecture context for each application without uploading its checkout.


![Platform demonstration: Explore application modules, agent tools and connected storage in Codebase.](/docs/screenshots/codebase-light.webp)

## What the graph means

Codebase visualizes a submitted architecture summary: modules, services, relationships, and relevant repository context. It is not a live inventory of every deployed dependency merely because GitHub is connected.

Your agent can inspect the local checkout and publish a high-level scan through `publish_component_scan`. Exclude secrets, source file contents, and personal data from that summary.

## Publish from the CLI

```bash title="Terminal"
pnpm --filter @everock/cli start scan --file .everock/codebase-scan.json --component api
```

The scan must follow the versioned graph contract. The CLI validates the file and limits local uploads to 1 MB. Maps stay scoped by component so separate repositories do not overwrite one another's architecture.

## Keep it current

Publish a new summary when the architecture changes. The worker also contains optional repository-sync machinery, but it needs its configured GitHub/model infrastructure; do not treat that path as universally enabled for every installation.

A scan gives an agent code context. Install the SDK for traffic, errors, request timing, and service-health observations.