Quickstart
Steps to scan your first code repository with Omlet CLI
The first step is to scan your repo using the Omlet CLI. Before we get started, make sure that your repo is locally available.
For example, if you manage your component library and your application(s) in separate repos, ensure they're all cloned locally and ready to go.
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.
npm i --save-dev @omlet/cli
Then, log in to Omlet CLI:
npx omlet login
This will open the browser with Omlet's login page. If the CLI doesn't detect the login, you can manually copy/paste the token to the CLI.
To start the component analysis, navigate to the root of the repo you wish to scan and run the Omlet CLI:
npx omlet init
init 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
Success! Your first analysis is complete. 🥳
To track and visualize the usage of your design system components, you'll need to tag them as Core. After the initial setup, you'll be able to make changes later on.
...and just like that, you'll see the list of all the components in your repo and the insights on how they are used!
🪄
If you encounter any issues, check the Troubleshoot page or contact us! You can also delete the scan and restart the
init setup process.
Last modified 1d ago