# Omlet Docs ## Omlet Docs - [Welcome! 🙌](https://docs.omlet.dev/readme.md) - [What is Omlet?](https://docs.omlet.dev/get-started/what-is-omlet.md): Learn more about Omlet—component analytics and insights for React. - [CLI & Dashboard](https://docs.omlet.dev/get-started/get-started.md): Step-by-step tutorial to help you get started with Omlet. - [Omlet for VS Code](https://docs.omlet.dev/omlet-for-vs-code.md): Guide to help you get started with Omlet's VS Code extension. - [CLI](https://docs.omlet.dev/cli-and-dashboard/learn-omlet-cli.md): Guide to help you get started with Omlet CLI and scan your codebase. - [Your first scan](https://docs.omlet.dev/cli-and-dashboard/learn-omlet-cli/your-first-scan.md): Learn how to run your first component scan with CLI's init command. - [Set up your dashbard](https://docs.omlet.dev/cli-and-dashboard/learn-omlet-cli/set-up-your-dashbard.md): Your component scan is completed. Let's buckle a few things up to start analyzing your design system. - [Future scans](https://docs.omlet.dev/cli-and-dashboard/learn-omlet-cli/future-scans.md): Learn how to scan more repositories with CLI's analyze command. - [Ensure data accuracy](https://docs.omlet.dev/cli-and-dashboard/learn-omlet-cli/ensure-data-accuracy.md): Things you'll need to know to ensure you have accurate and consistent component data. - [Config file](https://docs.omlet.dev/cli-and-dashboard/learn-omlet-cli/config-file.md): Learn more about the CLI configuration and their use cases. - [Exports configuration](https://docs.omlet.dev/cli-and-dashboard/learn-omlet-cli/config-file/resolve-imports-from-external-dependencies.md) - [Mapping aliases](https://docs.omlet.dev/cli-and-dashboard/learn-omlet-cli/config-file/map-aliases.md) - [Excluding certain components & files](https://docs.omlet.dev/cli-and-dashboard/learn-omlet-cli/config-file/excluding-certain-components-and-files.md): Need to exclude certain components and files from scans? - [Tutorial: Config file](https://docs.omlet.dev/cli-and-dashboard/learn-omlet-cli/config-file/tutorial-config-file.md) - [Custom component properties](https://docs.omlet.dev/cli-and-dashboard/learn-omlet-cli/custom-component-properties.md): Learn using the CLI hooks to add custom component properties to your scan data. - [CLI hooks](https://docs.omlet.dev/cli-and-dashboard/learn-omlet-cli/custom-component-properties/cli-hooks.md): Learn more about CLI hooks to add custom component properties. - [Tutorial 1: Team/code owner usage](https://docs.omlet.dev/cli-and-dashboard/learn-omlet-cli/custom-component-properties/tutorial-1-team-code-owner-usage.md): Step-by-step tutorial to add Team/Codeowner information to components and analyze them. - [Tutorial 2: Package version tracking](https://docs.omlet.dev/cli-and-dashboard/learn-omlet-cli/custom-component-properties/tutorial-2-package-version-tracking.md): Step-by-step tutorial for tracking the usage of package versions. - [Other example scripts](https://docs.omlet.dev/cli-and-dashboard/learn-omlet-cli/custom-component-properties/other-example-scripts.md) - [Set up regular scans](https://docs.omlet.dev/cli-and-dashboard/learn-omlet-cli/set-up-regular-scans.md): Things you'll need to know while setting up regular scans. - [CLI commands](https://docs.omlet.dev/cli-and-dashboard/learn-omlet-cli/commands.md): Omlet CLI has three main commands: init, analyze, login. Here are the details on available options for each command and when you can use them. - [init](https://docs.omlet.dev/cli-and-dashboard/learn-omlet-cli/commands/init.md) - [analyze](https://docs.omlet.dev/cli-and-dashboard/learn-omlet-cli/commands/analyze.md) - [login](https://docs.omlet.dev/cli-and-dashboard/learn-omlet-cli/commands/login.md) - [Analytics](https://docs.omlet.dev/cli-and-dashboard/analytics.md): Guide to learn the key Analytics features that will help you measure the component adoption and demonstrate the value of your design system. - [Popular charts](https://docs.omlet.dev/cli-and-dashboard/analytics/popular-charts.md): Learn the default charts provided by Omlet. - [Create custom charts](https://docs.omlet.dev/cli-and-dashboard/analytics/create-custom-charts.md): Learn how to create custom charts, and find answers to your unique questions. - [Save charts to dashboard](https://docs.omlet.dev/cli-and-dashboard/analytics/save-charts-to-dashboard.md): Learn more about Saved Dashboard and how you can add your custom charts to it. - [Share charts and dashboards with your team](https://docs.omlet.dev/cli-and-dashboard/analytics/share-charts-and-dashboards-with-your-team.md): Learn how to share your charts and dashboards with your team. - [Download chart data](https://docs.omlet.dev/cli-and-dashboard/analytics/download-chart-data.md): Learn how to download your chart data as a CSV file to import them to a spreadsheet or a data analytics tool. - [Components](https://docs.omlet.dev/cli-and-dashboard/components.md): Learn how to tag your components and get insights into individual components. - [Search and filter components](https://docs.omlet.dev/cli-and-dashboard/components/component-catalog.md): Learn how to search and filter the components. - [Component tags](https://docs.omlet.dev/cli-and-dashboard/components/use-tags-for-custom-analyses.md): Learn how to create tags to use in your custom analyses. - [Dependency Tree](https://docs.omlet.dev/cli-and-dashboard/components/dependency-tree.md): Learn the Dependency Tree and how it can help improve your design system. - [Props tracking](https://docs.omlet.dev/cli-and-dashboard/components/props-tracking.md): Learn more about Props tracking in Omlet. - [Workspace & Account](https://docs.omlet.dev/cli-and-dashboard/workspace-and-account.md) - [Invite team members](https://docs.omlet.dev/cli-and-dashboard/workspace-and-account/invite-team-members.md): Learn how to invite team members to collaborate with them. - [Renaming projects](https://docs.omlet.dev/cli-and-dashboard/workspace-and-account/renaming-projects.md): Learn how to update project names in Omlet. - [Update your email address](https://docs.omlet.dev/cli-and-dashboard/workspace-and-account/update-your-email-address.md): Learn how to change your account's email address. - [Access your billing details & invoices](https://docs.omlet.dev/cli-and-dashboard/workspace-and-account/access-your-billing-details-and-invoices.md): Learn how to view your plan details, update billing information and download invoices. - [Security in Omlet](https://docs.omlet.dev/security/security-in-omlet.md): More on what data Omlet collects and its security controls - [Data collection](https://docs.omlet.dev/security/data-collection.md) - [Pricing](https://docs.omlet.dev/help/pricing.md): Learn more about the 30-day trial and Omlet's pricing & plans. - [FAQs](https://docs.omlet.dev/help/faqs.md): Frequently asked questions for Omlet CLI. - [How detection works?](https://docs.omlet.dev/help/faqs/how-detection-works.md): Learn how Omlet detects components, props and their usages. - [Monorepo support](https://docs.omlet.dev/help/faqs/monorepo-support.md): Learn more about the monorepo support and which configurations are supported. - [How to delete scans?](https://docs.omlet.dev/help/faqs/how-to-delete-scans.md): Learn how to delete your scans. - [Omlet vs. React Scanner](https://docs.omlet.dev/help/faqs/omlet-vs.-react-scanner.md): Learn the differences between Omlet vs. React Scanner. - [Working with multiple workspaces](https://docs.omlet.dev/help/faqs/working-with-multiple-workspaces.md): Learn how you can work with multiple workspaces. - [Troubleshooting](https://docs.omlet.dev/help/troubleshooting.md): Learn how to address and troubleshoot common CLI issues. - [Debugging CLI issues](https://docs.omlet.dev/help/troubleshooting/debugging-cli-issues.md) - [Some components aren't detected](https://docs.omlet.dev/help/troubleshooting/some-components-arent-detected.md) - [API failed or timeout](https://docs.omlet.dev/help/troubleshooting/api-failed-or-timeout.md) - [Are you behind a proxy?](https://docs.omlet.dev/help/troubleshooting/are-you-behind-a-proxy.md) - [Troubleshooting Git errors](https://docs.omlet.dev/help/troubleshooting/troubleshooting-git-errors.md) - [Changelog](https://docs.omlet.dev/changelog.md): Announcements and release notes. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://docs.omlet.dev/readme.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.