Learn Omlet CLI

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

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.

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.

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?

You can invite a developer to scan the repositories.

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

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

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

Last updated