Skip to content
scoutuiPublic

About

Measure design-system adoption and component usage across every repo.

Topics

Resources

Contributing

Security policy

Stars

3 stars

Watchers

0 watching

Forks

Repository files navigation

Scout

See how your design system is used across every repo.

An open-source dashboard and CLI that track which components your teams use, where, and on which version.

Documentation • Scan a repo • Deploy the dashboard • Discussions

npm OpenSSF Scorecard License: MIT

What is Scout?

Scout is an adoption dashboard for design-system teams. Its CLI scans a React, Vue or Angular repository, web components included, and records every component the code uses, where it's used and with which props. The dashboard collects those scans from all your repos, so you can see adoption at a glance, plan migrations and track each one until it's done.

Features

  • Adoption across repos: see which repos use each component, and on which version.
  • Every use: open a component to see each file and line that uses it, and the props passed.
  • Migrations and retirements: mark a package or component as replaced or retired, and track each repo until it moves off.
  • History: Scout keeps a scan for each commit, so charts show how adoption changes over time.
  • Scans from CI: upload a fresh scan on every merge, so the dashboard stays current.

Get started

Install the CLI in the repo you want to scan (Node 24 or later):

npm i -D @scoutui/cli
npx scout init
npx scout scan --dry-run

The dry run writes scout-scan.json next to the config without uploading it. Scan your first repo walks through the result.

To share scans with your team, deploy the dashboard on Kubernetes with the Helm chart, then upload scans from CI. To try the dashboard first, run it locally.

Contributing

Bug reports, ideas and fixes are welcome in GitHub Issues, and questions in GitHub Discussions. The contributing guide explains how to set up the repository. To report a security issue, follow SECURITY.md.

License

Scout is open-source software under the MIT License.

About

Measure design-system adoption and component usage across every repo.

Topics

Resources

Contributing

Security policy

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages