README.md

Omlet documentation

New to Omlet? Follow the project README to get a local instance running.

Coming from the hosted version at omlet.dev? See Migrating from the hosted version.

CLI

• Overview
• Your first scan
• Set up your dashboard
• Future scans
• Ensure data accuracy
• Config file
  • Exports
  • Aliases
  • Excluding files
  • Tutorial
• Custom component properties
  • CLI hooks
  • Tutorial: team/code owner
  • Tutorial: package version
  • Example scripts
• Set up regular scans
• Commands
  • init
  • analyze
  • login

Dashboard

• Analytics
  • Popular charts
  • Create custom charts
  • Save charts to dashboard
  • Share charts and dashboards
  • Download chart data
• Components
  • Component catalog
  • Tags
  • Dependency tree
  • Props tracking
• Workspace & account
  • Invite team members
  • Renaming projects
  • Update your email address

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?
• Git errors