PHPackages                             quellabs/sculpt - 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. quellabs/sculpt

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

quellabs/sculpt
===============

Sculpt - Command Line Toolkit for the Quellabs Ecosystem

1.0.29(1mo ago)014610MITPHP

Since Jun 3Pushed 1mo ago1 watchersCompare

[ Source](https://github.com/quellabs/sculpt)[ Packagist](https://packagist.org/packages/quellabs/sculpt)[ RSS](/packages/quellabs-sculpt/feed)WikiDiscussions main Synced today

READMEChangelog (3)Dependencies (11)Versions (14)Used By (10)

Sculpt: Modern CLI Framework for Quellabs Ecosystem
===================================================

[](#sculpt-modern-cli-framework-for-quellabs-ecosystem)

[![Sculpt Logo](https://camo.githubusercontent.com/5c5c703587ca575e04c7e824cbada1a390229c93f3cec7b6d2340acaa5de9009/68747470733a2f2f7669612e706c616365686f6c6465722e636f6d2f313530783135302e706e673f746578743d5363756c7074)](https://camo.githubusercontent.com/5c5c703587ca575e04c7e824cbada1a390229c93f3cec7b6d2340acaa5de9009/68747470733a2f2f7669612e706c616365686f6c6465722e636f6d2f313530783135302e706e673f746578743d5363756c7074)

A powerful, extensible command-line toolkit that seamlessly integrates with ObjectQuel ORM.

[![Latest Stable Version](https://camo.githubusercontent.com/322d7f2a3d6d933391da4107d9d172d673f7ae0de414a209e7b1effaaa81b3e1/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f7175656c6c6162732f7363756c70742e737667)](https://packagist.org/packages/quellabs/sculpt)[![License](https://camo.githubusercontent.com/074b89bca64d3edc93a1db6c7e3b1636b874540ba91d66367c0e5e354c56d0ea/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e737667)](LICENSE)[![PHP Version](https://camo.githubusercontent.com/c7411e0d6faf9f58c0f8a3c52d2a497eff8d96a2488b8022f29b09506cc25039/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f7175656c6c6162732f7363756c70742e737667)](https://packagist.org/packages/quellabs/sculpt)

🚀 Overview
----------

[](#-overview)

Sculpt provides an elegant command-line interface for rapid development, code generation, and project management within the Quellabs ecosystem. It's designed to be intuitive for beginners yet powerful enough for advanced use cases.

✨ Features
----------

[](#-features)

- **Unified Command Interface** — Access commands from across the Quellabs ecosystem through a single CLI tool
- **Service Provider Architecture** — Robust plugin system allowing packages to register commands and services
- **Extensible Design** — Built from the ground up for customization and extension
- **Smart Discovery** — Automatically detects and loads commands from installed packages
- **Cross-Package Integration** — Enables seamless interaction between ObjectQuel and other components
- **Developer-Friendly** — Intuitive command structure with helpful documentation and auto-completion
- **Parameter Management** — Sophisticated handling of command-line parameters with validation and type checking

📦 Installation
--------------

[](#-installation)

```
composer require quellabs/sculpt
```

🔍 Quick Start
-------------

[](#-quick-start)

Once installed, you can run Sculpt commands using:

```
vendor/bin/sculpt
```

To see all available commands:

```
vendor/bin/sculpt
```

For detailed help on a specific command:

```
vendor/bin/sculpt help
```

📖 Documentation
---------------

[](#-documentation)

### Core Concepts

[](#core-concepts)

Sculpt is built around a few key concepts:

1. **Commands** — The primary way users interact with Sculpt
2. **Service Providers** — Register commands and extend functionality
3. **Configuration Manager** — Handles command parameters and options

### Command Structure

[](#command-structure)

Commands in Sculpt follow a namespace pattern:

```
namespace:command

```

For example:

- `db:migrate` — Run database migrations
- `make:model` — Generate a model class
- `cache:clear` — Clear application cache

### Using Command Parameters

[](#using-command-parameters)

Sculpt supports various parameter formats:

```
# Named parameters
vendor/bin/sculpt make:model --name=User --table=users

# Flags
vendor/bin/sculpt migrate --force --verbose

# Short flags
vendor/bin/sculpt migrate -fv

# Positional parameters
vendor/bin/sculpt make:controller User
```

🔧 Extending Sculpt
------------------

[](#-extending-sculpt)

### Creating a Service Provider

[](#creating-a-service-provider)

Sculpt uses a service provider pattern to discover and register commands from packages.

#### 1. Create a Service Provider Class

[](#1-create-a-service-provider-class)

```