sheaf/cli

A CLI tool for Sheaf UI

v1.0.12 2025-09-02 18:19 UTC

Requires (Dev)

• orchestra/testbench: ^10.4
• pestphp/pest: ^3.8
• pestphp/pest-plugin-laravel: ^3.2

MIT

• Youssef ACHCHIRAJ

• package
• cli
• laravel
• laravel-package
• artisan-command
• sheaf

README

A powerful command-line tool that streamlines component installation, theme management, and project setup to accelerate your Laravel development workflow with beautiful, accessible UI components.

Quick Start

Install the Sheaf CLI package in your Laravel project:

composer require sheaf/cli

Initialize Sheaf with all required dependencies:

php artisan sheaf:init

Start installing components:

php artisan sheaf:install button

Requirements

• Laravel 10.0 or higher
• PHP 8.1 or higher
• Alpine.js (auto-installed if not present)
• Tailwindcss 4.0 or higher

Features

One-Command Setup

The sheaf:init command sets up your entire project with CSS theme system, dark mode support, JavaScript utilities, and proper file organization.

Comprehensive Theme System

Built-in support for light/dark themes with CSS custom properties and Alpine.js integration for seamless theme switching.

Smart Component Installation

Install components with automatic dependency resolution. Each component includes all required files and dependencies.

Component Discovery

Browse and filter available components with sheaf:list to find exactly what you need for your project.

Installation Options

Interactive Setup

php artisan sheaf:init

Quick Setup with All Features

php artisan sheaf:init --with-dark-mode --with-phosphor

Custom Configuration

php artisan sheaf:init --css-file=custom.css --theme-file=my-theme --skip-prompts

Component Management

Install Components

# Install a single component
php artisan sheaf:install button

# Install with options
php artisan sheaf:install modal --force --no-deps

Browse Components

# List all components
php artisan sheaf:list

# Filter by access level
php artisan sheaf:list

File Structure

After initialization, Sheaf creates this organized structure:

resources/
├── css/
│   ├── app.css (updated with theme import)
│   └── theme.css (CSS custom properties)
├── js/
│   ├── utils.js (Alpine.js utilities)
│   ├── app.js (updated with imports)
│   └── globals/
│       └── theme.js (Dark mode system)
└── views/
    └── components/
        └── ui/ (installed components)

Documentation

Visit sheafui.dev for:

• Complete component documentation
• Usage examples
• Theme customization guides
• Advanced configuration options

License

Sheaf CLI is open-source software. Premium components require a valid license.