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
  1. CLI & Dashboard
  2. CLI

Custom component properties

Learn using the CLI hooks to add custom component properties to your scan data.

Last updated 3 months ago

Omlet provides built-in component properties in analysis, such as file path, component name, and package name. Along with these properties, you can also add your custom properties to components.

This helps you define and track custom usage metrics and automatically apply tags based on different rules and attributes — giving you a more accurate view of how components are being used across your entire organization.

By adding custom properties, you can:

  • Automatically tag and track components based on their category, such as Icons or Pages

  • Automatically tag and track components that are, or should be, deprecated

  • Identify all the components created by a particular product team or user

  • Find components that have missing documentation or tests

  • Differentiate visual vs. non-visual components

  • Track package versions used across your projects

Continue with learning more about CLI hooks to add custom properties to components:

CLI hooks