# Scout

> Design-system usage analytics for React and Vue

This file contains links to documentation sections following the llmstxt.org standard.

## Table of Contents

- [How the CLI and the dashboard fit together](https://scoutui.dev/docs/explanation/cli-and-dashboard.md): How the CLI and the dashboard divide the work, what happens to a scan after you upload it, and what "Preparing scan data" means.
- [Composition: renders and rendered by](https://scoutui.dev/docs/explanation/composition-and-ownership.md): What "renders" and "rendered by" mean in Scout, how they differ from how tags nest in your markup, which frameworks record them, and how they show ...
- [Reading the numbers](https://scoutui.dev/docs/explanation/dashboard/reading-the-numbers.md): Why the dashboard's counts, versions, deprecated marks, migration percentages and shares are shaped the way they are.
- [How components are found](https://scoutui.dev/docs/explanation/mental-model.md): What a Scout scan counts as a component: every component it sees gets an entry, there are three kinds matched across repos in different ways, and p...
- [Authenticate the CLI for uploads](https://scoutui.dev/docs/guides/authenticate-uploads.md): Sign the Scout CLI in to a dashboard so scout scan uploads as you, and control which dashboard your uploads go to.
- [Configure a scan](https://scoutui.dev/docs/guides/configure-a-scan.md): Create scout.config.json with init, point it at the files you want scanned, and check that the scan reads them.
- [Charts](https://scoutui.dev/docs/guides/dashboard/charts.md): Follow every migration and retirement across your repos, and build saved charts that compare libraries, packages or components scan by scan.
- [Find where a component is used](https://scoutui.dev/docs/guides/dashboard/find-where-a-component-is-used.md): Open a component to see every repo that uses it and which version each is on, then the props, values, files and lines that use it in one repo.
- [Packages and versions](https://scoutui.dev/docs/guides/dashboard/packages.md): See which packages your repos use, which are on more than one version and which carry deprecated components, then open a package to see who uses it...
- [Repos](https://scoutui.dev/docs/guides/dashboard/repos.md): See which components each repo uses, what changed since its previous scan, and how to filter, share and look back through a repo's scans.
- [Tags](https://scoutui.dev/docs/guides/dashboard/tag-your-libraries.md): Group packages into libraries with tags, so you can filter by library and compare libraries in charts.
- [Migrations and retirements](https://scoutui.dev/docs/guides/dashboard/track-a-migration.md): Record that a package or component is superseded or retired, see it marked deprecated in every repo, and follow each repo's progress until no one u...
- [Deploy the dashboard](https://scoutui.dev/docs/guides/deploy-the-dashboard.md): Deploy the Scout dashboard and its worker to Kubernetes with the Helm chart, an OIDC identity provider and Postgres, then keep it running through u...
- [Deploy the dashboard with your own chart](https://scoutui.dev/docs/guides/deploy-with-your-own-chart.md): Run the Scout dashboard image under your own Helm chart or a platform-provided one: the web server and the worker, their environment, migrations, m...
- [Install the CLI](https://scoutui.dev/docs/guides/install.md): Add the Scout CLI to a repo as a dev dependency, switch Yarn off Plug'n'Play if needed, and check that the command runs.
- [Link web components to your package](https://scoutui.dev/docs/guides/link-web-components-to-your-package.md): Point your package of web components at its Custom Elements Manifest, so its tags in other repos belong to your package, with a version that lifecy...
- [Resolve imports in a monorepo](https://scoutui.dev/docs/guides/resolve-imports-in-a-monorepo.md): Make path aliases and workspace package imports resolve, so every component your code imports is found and listed under the right package.
- [Run a scan and upload in CI](https://scoutui.dev/docs/guides/run-in-ci.md): Run scout scan from a GitHub Actions job to upload each scan, using a CI upload token instead of a personal sign-in.
- [Run the dashboard locally](https://scoutui.dev/docs/guides/run-the-dashboard-locally.md): Run the Scout dashboard and its worker on your machine with Postgres and the dev sign-in, then sign the CLI in and upload a scan.
- [Troubleshoot a scan](https://scoutui.dev/docs/guides/troubleshoot-a-scan.md): Match what a failing or incomplete scout scan prints to its cause, and fix it.
- [Upgrade Scout](https://scoutui.dev/docs/guides/upgrade-scout.md): Upgrade the Scout dashboard and the CLI, and fix a scan refused because the CLI is newer or older than the dashboard.
- [Scout](https://scoutui.dev/docs/overview.md): What Scout does, what it reads, and where to start depending on whether you read the dashboard, scan repos, or run the dashboard for your team.
- [Scan artifact reference](https://scoutui.dev/docs/reference/artifact.md): Every field in the JSON file scout scan uploads and scout scan --dry-run writes: meta, components, occurrences and diagnostics.
- [CLI reference](https://scoutui.dev/docs/reference/cli.md): Every command, flag, default, exit code and environment variable the Scout CLI accepts.
- [Config reference](https://scoutui.dev/docs/reference/config.md): Every field in scout.config.json, with its type, default and what paths are relative to, plus repo-id resolution and validation errors.
- [Diagnostics reference](https://scoutui.dev/docs/reference/diagnostics.md): Every diagnostic code a Scout scan reports: severity, fields, what it means, what to do, and how it prints in the terminal.
- [Framework support reference](https://scoutui.dev/docs/reference/framework-support.md): What a Scout scan reads in React and Vue files: which files, how React, Vue and web components are recognised, whether renders and rendered by are ...
- [Glossary](https://scoutui.dev/docs/reference/glossary.md): What the words Scout uses mean, in the dashboard and in the scan's JSON: component, occurrence, scan, tag, lifecycle record and more.
- [Explore the dashboard](https://scoutui.dev/docs/tutorials/explore-the-dashboard.md): Upload a scan to the dashboard, then find the repo, read its components and calls, tag its libraries, record a migration and watch it on a chart.
- [Scan your first repo](https://scoutui.dev/docs/tutorials/scan-your-first-repo.md): Install the Scout CLI in a repo that uses a design system, run a first scan, and read the components it found in the JSON file it writes.