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
  • Before you begin
  • Prepare your codebase
  • Framework & platform support
  1. CLI & Dashboard

CLI

Guide to help you get started with Omlet CLI and scan your codebase.

PreviousOmlet for VS CodeNextYour first scan

Last updated 9 months ago

Omlet provides component analytics and insights for React by utilizing the component usage data from your codebase. With this guide, you'll learn to set up Omlet CLI and scan your codebase.

Before you begin

Before we jump in, make sure to create your account. Omlet will walk you through setting up your workspace. If a teammate already has one, they can send you an invite.

Prepare your codebase

The first step is to scan your codebase using the CLI—make sure that your codebase is locally available. If you manage your component library and your application(s) in separate repositories, ensure they're all cloned locally and ready to go.

No access to the codebase?

Omlet considers each package a separate project so that you can track usages individually. Some of the supported setups include:

  • Single repo that includes both your application and component library

  • Monorepo with multiple packages and your component library

  • Multiple application repos and a separate component library

Framework & platform support

You can to scan the repositories.

Omlet currently supports React and React Native. We'll be adding support for other frameworks and platforms in the future — share your feedback .

If you prefer, you can also scan an open-source project. In this tutorial, we'll be using as an example.

invite a developer
here
Proton

If you haven't used Omlet before, sign up for an account and create your workspace.

If your team already has a workspace, you can ask them to invite you.

Create your account
Inviting team members