# Srcly > Srcly is a local codebase map for developers and coding agents. It scans a repository into folders, files, functions and nested scopes, measures complexity, size, comment noise, React and Solid components, Git activity and lint findings, and shows them as a treemap, graphs and a 2x2 in the browser. Headless commands write the same analysis as Markdown and JSON. Run it with `uvx srcly` (needs uv; Python 3.13+). Version 1.12.0. Full analysis for TypeScript, JavaScript and Python; size and complexity for the other languages Lizard reads. A metric that does not apply is N/A, never 0. For an agent, the usual loop is: 1. `uvx srcly report . --out .srcly`, then read `.srcly/report.md`. 2. `uvx srcly explain . --at ` to drill in. Each answer ends with a `Next:` command. 3. `uvx srcly compare --json` to see what a change did, and `uvx srcly check . --ratchet` to stop big files from growing. ## Guides - [Understand a codebase with Srcly](https://byronwall.github.io/srcly/docs/overview/index.md): Srcly helps you move from a broad view of a repository to the exact code behind a signal. - [Product tour](https://byronwall.github.io/srcly/docs/tour/index.md): Srcly is designed for one practical loop: orient yourself in a codebase, choose a useful signal, inspect the code behind it, and decide what to do next. - [Design decisions](https://byronwall.github.io/srcly/docs/design/index.md): Srcly combines a visual code map with source-level evidence and repeatable terminal output. - [Get started](https://byronwall.github.io/srcly/docs/get-started/index.md): Run Srcly on a repository, choose one review question, and follow its evidence into the source. - [Explore a codebase](https://byronwall.github.io/srcly/docs/explore/index.md): Use Srcly's linked views to move from a broad signal to the source behind it. - [Review changes](https://byronwall.github.io/srcly/docs/changes/index.md): The Changes view shows the code a window of Git history edited. - [Understand metrics](https://byronwall.github.io/srcly/docs/metrics/index.md): Use metrics to decide where to inspect, then check the code that produced the value. - [Findings and check coverage](https://byronwall.github.io/srcly/docs/findings/index.md): Findings bring selected checker results into Srcly's explorer, code viewer, and reports. - [Data-flow analysis](https://byronwall.github.io/srcly/docs/data-flow/index.md): Data flow traces how values move through supported source code. - [Reports for agents and CI](https://byronwall.github.io/srcly/docs/reports/index.md): Use report to scan a repository and write a Markdown summary plus JSON artifacts. - [Command-line reference](https://byronwall.github.io/srcly/docs/cli/index.md): Srcly has an interactive command and headless commands for scripts, agents, and CI. - [Configuration](https://byronwall.github.io/srcly/docs/configuration/index.md): Most users can start Srcly without a configuration file. ## Reference - [Metrics](https://byronwall.github.io/srcly/metrics.md): every metric with its ID, rollup, languages and definition. - [Agent skill](https://raw.githubusercontent.com/byronwall/srcly/main/skills/srcly-code-quality/SKILL.md): the report and explain workflow as a skill file. - [Source](https://github.com/byronwall/srcly): the repository. ## Optional - [Everything in one file](https://byronwall.github.io/srcly/llms-full.txt): every guide and the metric reference.