README

A command-line interface for standalone use of Laravel's Illuminate components.

Introduction

This package provides a CLI for various Laravel Illuminate components, making them available as standalone command-line utilities without a full Laravel application.

Some components are thin wrappers around native functionality, while others extend or customize the originals to improve usability from the terminal.

Requirements

• PHP 8.2 or higher
• Composer

Installation

composer global require "surgiie/illuminate-cli"

Usage

illuminate --help

See the syntax documentation and the per-component docs linked below.

Supported Components

Note: Supported components are not necessarily fully implemented or feature-complete. Some features may not translate cleanly to a CLI context. If you encounter missing functionality, please open an issue.

Development

Setup

git clone https://github.com/surgiie/illuminate-cli.git
cd illuminate-cli
composer install

Testing

composer test

Code Quality

# Run PHPStan static analysis
composer phpstan

# Check code formatting
composer format:test

# Fix code formatting
composer format

Contributing

Please see CONTRIBUTING.md for details on how to contribute.