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
  3. CLI commands

init

PreviousCLI commandsNextanalyze

Last updated 1 year ago

init command will take you through a guided process to scan your repo(s) based on your setup. Some of the supported setups include:

  • A single repo that includes both your application and component library

  • A monorepo with multiple packages and your component library

  • Multiple application repos and a separate component library repo

If you need to restart the init setup process, you can that were created.

-r / --root

Set where Omlet CLI will run the analysis. This option will come in handy if you are running the CLI from a directory that is different from the directory of the project you are trying to scan.

By default, the project root is the current working directory of the terminal. If that directory doesn't contain a package.json file, the CLI will attempt to find the closest package.json up in the directory hierarchy, starting from the current directory to determine the project root.

The CLI will also display an output in the terminal which indicates the root where it is running the scan:

Analyzing the project at <PATH>…

--log-level

Specify the log level for the CLI. Possible values you can pass: error, warn, info, debug, trace

-v / --verbose

By default, it is set as false. Adding this option will give you detailed log output in the CLI.

-h / --help

omlet init -h will provide all the available options you can use to run the analyze command with some explanations.

delete scans