PHPackages                             amsiam/lara-ui-cli - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [CLI & Console](/categories/cli)
4. /
5. amsiam/lara-ui-cli

ActiveLibrary[CLI & Console](/categories/cli)

amsiam/lara-ui-cli
==================

CLI tool for installing LaraUI components in Laravel projects

1.0.0(3mo ago)02MITPHPPHP ^8.2

Since Jan 29Pushed 3mo agoCompare

[ Source](https://github.com/Amsiam/lara-ui-cli)[ Packagist](https://packagist.org/packages/amsiam/lara-ui-cli)[ RSS](/packages/amsiam-lara-ui-cli/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (6)Versions (2)Used By (0)

LaraUI CLI
==========

[](#laraui-cli)

A CLI tool for adding LaraUI components to your Laravel project. Similar to shadcn/ui CLI, this tool fetches components from the LaraUI registry and installs them directly into your project.

Installation
------------

[](#installation)

```
composer require amsiam/lara-ui-cli --dev
```

Quick Start
-----------

[](#quick-start)

### 1. Initialize your project

[](#1-initialize-your-project)

```
php artisan ui:init
```

This will:

- Create a `lara-ui.json` configuration file
- Install CSS variables to `resources/css/lara-ui.css`
- Update your `app.css` to import the styles

### 2. Add components

[](#2-add-components)

```
# Add specific components
php artisan ui:add button card input

# Add all components
php artisan ui:add all

# Interactive selection
php artisan ui:add
```

### 3. Use components

[](#3-use-components)

```
Click me

        Hello

        Content here

```

Commands
--------

[](#commands)

### `ui:init`

[](#uiinit)

Initialize LaraUI in your project.

```
php artisan ui:init [--force] [--yes] [--registry=]
```

OptionDescription`--force`Overwrite existing configuration`--yes`Skip prompts, use defaults`--registry=`Custom registry URL (default: GitHub)**Examples:**

```
# Default initialization (uses official LaraUI registry)
php artisan ui:init

# Use custom registry
php artisan ui:init --registry=https://your-domain.com/components

# Quick setup with defaults
php artisan ui:init --yes

# Custom registry with defaults
php artisan ui:init --yes --registry=http://localhost:8000/packages/laraui
```

### `ui:add`

[](#uiadd)

Add components to your project.

```
php artisan ui:add [components...] [--all] [--force] [--deps] [--path=]
```

OptionDescription`--all`Install all available components`--force`Overwrite existing files`--deps`Skip dependency installation`--path=`Custom installation path**Examples:**

```
# Add specific components
php artisan ui:add button card dialog

# Add all components
php artisan ui:add all

# Interactive multi-select
php artisan ui:add

# Force overwrite existing
php artisan ui:add button --force

# Custom path
php artisan ui:add button --path=resources/ui
```

### `ui:list`

[](#uilist)

List available components.

```
php artisan ui:list [--category=] [--installed] [--available] [--json] [--refresh]
```

OptionDescription`--category=`Filter by category (core, forms, feedback, etc.)`--installed`Show only installed components`--available`Show only not-installed components`--json`Output as JSON`--refresh`Refresh the registry cache### `ui:diff`

[](#uidiff)

Check for updates to installed components.

```
php artisan ui:diff [component] [--all]
```

OptionDescription`component`Specific component to check`--all`Check all installed componentsConfiguration
-------------

[](#configuration)

After running `ui:init`, a `lara-ui.json` file is created in your project root:

```
{
    "registry": "https://raw.githubusercontent.com/amsiam/lara-ui/main",
    "aliases": {
        "components": "resources/views/components/ui",
        "utils": "app/View/Components/LaraUi"
    },
    "tailwind": {
        "css": "resources/css/app.css"
    },
    "prefix": "ui"
}
```

### Configuration Options

[](#configuration-options)

KeyDescriptionDefault`registry`URL of the component registryGitHub raw URL`aliases.components`Where Blade views are installed`resources/views/components/ui``aliases.utils`Where PHP classes are installed`app/View/Components/LaraUi``tailwind.css`Path to your main CSS file`resources/css/app.css``prefix`Component prefix (e.g., `x-ui::`)`ui`### Custom Registry

[](#custom-registry)

You can host your own component registry by setting the `registry` URL:

```
{
    "registry": "https://your-domain.com/lara-ui"
}
```

The registry must have a `registry.json` file and the component files at the expected paths.

How It Works
------------

[](#how-it-works)

1. **Initialization** (`ui:init`)

    - Creates configuration file
    - Downloads CSS variables from registry
    - Sets up your project for LaraUI
2. **Adding Components** (`ui:add`)

    - Fetches component files from the registry (GitHub)
    - Resolves and installs dependencies automatically
    - Transforms namespaces and prefixes for your project
    - Copies files to your configured paths
3. **Component Ownership**

    - Components are copied to your project
    - You own and can customize them fully
    - No runtime dependency on the registry

Requirements
------------

[](#requirements)

- PHP 8.2+
- Laravel 11 or 12
- Tailwind CSS 4
- Alpine.js 3.x (for interactive components)

Dependencies
------------

[](#dependencies)

After installing components, ensure you have these packages:

```
# Required for class merging
composer require gehrisandro/tailwind-merge-laravel
```

License
-------

[](#license)

MIT License

###  Health Score

35

—

LowBetter than 80% of packages

Maintenance79

Regular maintenance activity

Popularity2

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity46

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

110d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/568955cf6bd00e134182d961aac373d058c486cab75d60a8daa077b2ab915a3a?d=identicon)[Amsiam](/maintainers/Amsiam)

---

Top Contributors

[![Amsiam0](https://avatars.githubusercontent.com/u/204317646?v=4)](https://github.com/Amsiam0 "Amsiam0 (6 commits)")

---

Tags

clilaraveluicomponentsinstallerblade

###  Code Quality

TestsPest

### Embed Badge

![Health badge](/badges/amsiam-lara-ui-cli/health.svg)

```
[![Health](https://phpackages.com/badges/amsiam-lara-ui-cli/health.svg)](https://phpackages.com/packages/amsiam-lara-ui-cli)
```

###  Alternatives

[laravel/ui

Laravel UI utilities and presets.

2.7k134.9M601](/packages/laravel-ui)[laravel-zero/framework

The Laravel Zero Framework.

3371.4M369](/packages/laravel-zero-framework)[livewire/flux

The official UI component library for Livewire.

9475.0M86](/packages/livewire-flux)[tightenco/jigsaw

Simple static sites with Laravel's Blade.

2.2k438.5k29](/packages/tightenco-jigsaw)[nunomaduro/laravel-console-menu

Laravel Console Menu is an output method for your Laravel/Laravel Zero commands.

815412.0k48](/packages/nunomaduro-laravel-console-menu)[roots/acorn

Framework for Roots WordPress projects built with Laravel components.

9682.1M97](/packages/roots-acorn)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)