reyhan-commerce / installer

v1.0.0 2026-10-02 22:18 UTC

Requires

• php: ^8.2
• laravel/prompts: ^0.3
• symfony/console: ^7.0|^6.4
• symfony/process: ^7.0|^6.4

MIT

• Farshid & Reyhan Contributors

Published on Packagist.org on 2026-10-02 22:25 UTC

README

🌿 Reyhan Commerce Installer (reyhan-commerce/installer)

The Official CLI Scaffolding Tool for Reyhan Commerce Framework

Quickly scaffold production-ready headless e-commerce stores with interactive Laravel Prompts

🚀 Installation

Install the Reyhan CLI installer globally via Composer:

composer global require reyhan-commerce/installer

Ensure your Composer global bin directory is in your system's $PATH:

• Linux / macOS: ~/.config/composer/vendor/bin or ~/.composer/vendor/bin
• Windows: %USERPROFILE%\AppData\Roaming\Composer\vendor\bin

Verify installation:

reyhan --version

🛠️ Scaffolding a New Store

To scaffold a new Reyhan headless commerce application, execute:

reyhan new my-store

The interactive terminal wizard powered by Laravel Prompts will guide you through:

1. Database Engine: Choose between PostgreSQL 17+ (recommended for native JSONB & trigram indexing), MySQL 8.0+, or SQLite.
2. Catalog Seeding: Optionally seed the comprehensive Iranian commerce demo catalog (provinces, cities, categories, products, inventory variants).
3. Environment Setup: Automatically configures .env, generates application keys, installs composer dependencies, and executes database migrations.

🤖 Non-Interactive / CI/CD Automation

You can skip interactive questions in CI pipelines, Docker builds, or scripted deployments:

# Provision with PostgreSQL and seed demo catalog non-interactively
reyhan new my-store --pgsql --seed --no-interaction

# Provision for rapid local testing with SQLite
reyhan new test-store --sqlite --seed --no-interaction

# Overwrite existing folder
reyhan new my-store --pgsql --force

Supported CLI Flags

Flag	Description
--pgsql	Configure PostgreSQL as the primary database engine
--mysql	Configure MySQL / MariaDB as the primary database engine
--sqlite	Configure SQLite for rapid local prototyping
--seed	Automatically run migrations and seed demo data
-f, --force	Overwrite destination directory if it already exists
--no-interaction	Bypass all interactive prompts with default values

⚡ Direct Composer Alternative

If you prefer not to install global binaries, you can create a new store directly using Composer:

composer create-project reyhan-commerce/reyhan my-store

📚 Ecosystem Repositories

Repository	Purpose	Packagist / Link
reyhan-commerce/installer	Composer Global CLI Scaffolder	reyhan-commerce/installer
reyhan-commerce/core	Framework Core Library	reyhan-commerce/core
reyhan-commerce/reyhan	Starter Application Skeleton	reyhan-commerce/reyhan
reyhan-commerce/storefront-nuxt	Nuxt 4 Commercial Storefront	GitHub Repository
reyhan-commerce/docs	Official VitePress Docs Site	Live Documentation

🤝 Contributing

Contributions are welcome! Please see CONTRIBUTING.md and AGENTS.md for architecture guidelines.

📄 License

Reyhan Commerce Installer is open-sourced software licensed under the MIT license.