Skip to content

list โ€‹

Displays a list of all available components.

bash
npx kuro-ui list
bash
npx github:Bartek-Nowak/Kuro list

๐Ÿ“‹ What does it display? โ€‹

  • Lists items from one or more categories (Components, Composables, Utils).

  • Shows:

    • Name and type (component, composable, util)

    • Description

    • Dependencies (npm packages) if any

    • Requires (other components) if any

๐ŸŽฏ Usage details โ€‹

  • By default, the CLI interactively prompts which categories to show.

  • To list all items without prompt, add the --all flag:

bash
npx kuro-ui list --all

๐Ÿงช Example output: โ€‹

bash
๐Ÿ› ๏ธ Available items:

๐Ÿ”น alert (component)
   ๐Ÿ“ Displays a prominent alert message with optional icon and title.

๐Ÿ”น useAsyncState (composable)
   ๐Ÿ“ Provides reactive async state management.

๐Ÿ”น button (component)
   ๐Ÿ“ Versatile button component with support for variants and sizes.

๐Ÿ”น stat (component)
   ๐Ÿ“ Presents numerical metrics or KPIs in a compact visual block.

๐Ÿ”น rating (component)
   ๐Ÿ“ Interactive star-based rating component supporting partial selection and read-only mode.
   ๐Ÿ“ฆ Dependencies: lucide-vue-next
   ๐Ÿค Requires: icon-toggle

๐Ÿ”ง Notes This command does not modify any files โ€” it only lists available items.

  • Categories selectable in prompt:

    • Components (Vue components)

    • Composables (Vue composables/hooks)

    • Utils (utility functions)

  • Use --all to skip category selection prompt.