Omlet Docs
BlogChangelogAsk the CommunityContact Sales
  • Get started
    • What is Omlet?
    • CLI & Dashboard
  • Omlet for VS Code
  • CLI & Dashboard
    • CLI
      • Your first scan
      • Set up your dashbard
      • Future scans
      • Ensure data accuracy
      • Config file
        • Exports configuration
        • Mapping aliases
        • Excluding certain components & files
        • Tutorial: Config file
      • Custom component properties
        • CLI hooks
        • Tutorial 1: Team/code owner usage
        • Tutorial 2: Package version tracking
        • Other example scripts
      • Set up regular scans
      • CLI commands
        • init
        • analyze
        • login
    • Analytics
      • Popular charts
      • Create custom charts
      • Save charts to dashboard
      • Share charts and dashboards with your team
      • Download chart data
    • Components
      • Search and filter components
      • Component tags
      • Dependency Tree
      • Props tracking
    • Workspace & Account
      • Invite team members
      • Renaming projects
      • Update your email address
      • Access your billing details & invoices
  • Security
    • Security in Omlet
    • Data collection
  • Help
    • Pricing
    • FAQs
      • How detection works?
      • Monorepo support
      • How to delete scans?
      • Omlet vs. React Scanner
      • Working with multiple workspaces
    • Troubleshooting
      • Debugging CLI issues
      • Some components aren't detected
      • API failed or timeout
      • Are you behind a proxy?
      • Troubleshooting Git errors
Powered by GitBook
On this page
  1. CLI & Dashboard
  2. CLI

Your first scan

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

PreviousCLINextSet up your dashbard

Last updated 11 months ago

The first scan goes through the 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:

npx @omlet/cli init
yarn dlx @omlet/cli init
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 .

support@omlet.dev
init