Your first scan

Learn how to run your first component scan with CLI's init command.

The first scan goes through the init command that takes you through a guided process.

We recommend scanning the repository that includes your design system components first.

To start the component analysis, navigate to the root of the repo you wish to scan and run:

npm

npx @omlet/cli init

yarn

yarn dlx @omlet/cli init

pnpm

pnpm dlx @omlet/cli init

This will install the latest version of the CLI and will ask you to log in to your Omlet account.

If the CLI doesn't detect the login, you can copy/paste the token manually.

If the repository you scanned includes only a single package, the CLI will prompt you to scan more repositories. Make sure to scan both the design system and the application projects. This will allow you to see the adoption of your design system for those projects.

If multiple packages are already scanned with init, such as a monorepo, the CLI will not prompt you to scan more repositories. You can scan them with the analyze command later on .

After completing the scans, follow the link to set up your analytics dashboard.

Need help?

If you need more help or have questions, feel free to contact us at [email protected].