fluxui-docs

Category: Docs & Knowledge | Uploader: fgilio | Downloads: 0 | Version: v1.0（Latest）

Livewire Flux UI component documentation lookup. Provides offline access to fluxui.dev documentation via CLI.

Changelog: Source: GitHub https://github.com/fgilio/fluxui-docs-skill

Directory Structure

Current level: skill/

📁 data/
- 📁 components/
  - 📄 accordion.json 2.3 KB
  - 📄 autocomplete.json 762 B
  - 📄 avatar.json 23.7 KB
  - 📄 badge.json 5.2 KB
  - 📄 brand.json 3.1 KB
  - 📄 breadcrumbs.json 2.7 KB
  - 📄 button.json 6.6 KB
  - 📄 calendar.json 9.3 KB
  - 📄 callout.json 11.1 KB
  - 📄 card.json 2.9 KB
  - 📄 chart.json 10.1 KB
  - 📄 checkbox.json 8.8 KB
  - 📄 command.json 1.9 KB
  - 📄 composer.json 4.9 KB
  - 📄 context.json 745 B
  - 📄 date-picker.json 10.7 KB
  - 📄 dropdown.json 7.4 KB
  - 📄 editor.json 8.1 KB
  - 📄 field.json 3.8 KB
  - 📄 file-upload.json 10.1 KB
  - 📄 heading.json 3.1 KB
  - 📄 icon.json 4.5 KB
  - 📄 input.json 7.8 KB
  - 📄 kanban.json 4.9 KB
  - 📄 modal.json 7.9 KB
  - 📄 navbar.json 5.7 KB
  - 📄 otp-input.json 4.3 KB
  - 📄 pagination.json 1.7 KB
  - 📄 pillbox.json 10.0 KB
  - 📄 popover.json 15.1 KB
  - 📄 profile.json 6.6 KB
  - 📄 radio.json 8.3 KB
  - 📄 select.json 14.8 KB
  - 📄 separator.json 1.5 KB
  - 📄 skeleton.json 3.5 KB
  - 📄 slider.json 5.3 KB
  - 📄 switch.json 2.3 KB
  - 📄 table.json 5.1 KB
  - 📄 tabs.json 6.3 KB
  - 📄 text.json 2.7 KB
  - 📄 textarea.json 2.1 KB
  - 📄 time-picker.json 3.8 KB
  - 📄 toast.json 3.6 KB
  - 📄 tooltip.json 3.1 KB
- 📁 guides/
  - 📄 customization.json 1.5 KB
  - 📄 dark-mode.json 2.3 KB
  - 📄 help.json 888 B
  - 📄 installation.json 3.6 KB
  - 📄 patterns.json 7.9 KB
  - 📄 principles.json 4.2 KB
  - 📄 theming.json 2.9 KB
  - 📄 upgrading.json 3.3 KB
- 📁 layouts/
  - 📄 header.json 5.9 KB
  - 📄 sidebar.json 7.7 KB
- 📄 index.json 54.1 KB
- 📄 usages.json 113.3 KB
📄 fluxui-docs 133 B
📄 install 181 B
📄 SETUP.md 287 B
📄 SKILL.md 3.4 KB

SKILL.md

---
name: fluxui-docs
description: >
  Livewire Flux UI component documentation lookup.
  Provides offline access to fluxui.dev documentation via CLI.
  Use for: component props, usage examples, code snippets, Livewire components.
  Keywords: Flux, Flux UI, fluxui, blade component.
user-invocable: true
disable-model-invocation: false
---

# Flux UI CLI

Offline Flux UI documentation with JSON output for Claude Code integration.

## Execution

`fluxui-docs` is a self-contained binary available on PATH.
Run it directly - never prefix with `bun`, `node`, `php`, or any runtime.

## Quick Reference

| Command | Purpose |
|---------|---------|
| `fluxui-docs docs` | List all components, layouts, guides |
| `fluxui-docs search <query>` | Fuzzy search documentation |
| `fluxui-docs show <name>` | Display full documentation |
| `fluxui-docs usages <component>` | Find where a component is used |
| `fluxui-docs discover` | List undocumented components |

## Commands

### fluxui-docs docs

List available documentation items.

```bash
fluxui-docs docs                          # List all
fluxui-docs docs --category=components    # Components only
fluxui-docs docs --json                   # JSON output
```

### fluxui-docs search

Search documentation by name or description.

```bash
fluxui-docs search button                 # Search for button
fluxui-docs search "date picker"          # Search phrase
fluxui-docs search input --json           # JSON output
```

### fluxui-docs show

Display full documentation for an item.

```bash
fluxui-docs show button                   # Show button docs
fluxui-docs show modal --section=props    # Show specific section
fluxui-docs show dropdown --json          # JSON output
```

### fluxui-docs usages

Find where a component is used in documentation examples. Works for any component, including undocumented ones like `flux:subheading`.

```bash
fluxui-docs usages subheading             # Find subheading usage
fluxui-docs usages modal.close            # Find sub-component usage
fluxui-docs usages button --json          # JSON output
```

Example output:
```
flux:subheading is used in:

  components/modal
    └─ Flyout
    └─ Floating flyout

Total: 1 page(s)
```

### fluxui-docs discover

List components found in code examples but without their own documentation page. Surfaces "hidden" components.

```bash
fluxui-docs discover                      # List all undocumented
fluxui-docs discover --json               # JSON output
```

Example output:
```
Sub-components (documented via parent):

  flux:modal.close
    → see: modal
    → used in: modal

  flux:modal.trigger
    → see: modal
    → used in: modal

Components in examples only (no dedicated docs):

  flux:subheading
    → used in: modal, card

  flux:spacer
    → used in: modal, dropdown

Summary:
  Sub-components: 2
  Undocumented: 2
```

## Usage Examples

```bash
# Find form components
fluxui-docs search form

# Get button variants
fluxui-docs show button

# List all components
fluxui-docs docs --category=components
```

## Data Location

Documentation is stored in `data/` directory (versioned in git):
- `data/components/` - Component JSON files
- `data/layouts/` - Layout JSON files
- `data/guides/` - Guide JSON files
- `data/index.json` - Search index
- `data/usages.json` - Component usage index (for usages/discover commands)

## Pro Components

Some components are marked as Pro-only (`[Pro]` badge, `"pro": true` in JSON). These require a Flux UI Pro license.

Comments 0

Latest | Hot

Please login before commenting.

No comments yet. Be the first one!

fluxui-docs

Directory Structure

SKILL.md

Report

Notice