acadex-cli

A global CLI tool for managing Acadex projects with easy setup and automation.

Installation

Via npm (Global)

npm install -g acadex-cli

If you get an error about existing files:

# On macOS/Linux
sudo rm -f /usr/local/bin/acadex /opt/homebrew/bin/acadex
npm install -g acadex-cli

# On Windows (PowerShell as Admin)
npm install -g acadex-cli --force

After installation, you can use the acadex command from anywhere:

acadex --help

Uninstall

To completely remove ACADEX CLI:

acadex uninstall

Or manually:

npm uninstall -g acadex-cli

Manual Installation

Clone the repository and link it globally:

git clone <repository-url>
cd acadex-cli-global
npm link

Usage

Interactive Menu (New in v1.1!)

Launch the interactive menu with arrow key navigation:

acadex menu

Navigate through categories using arrow keys and select commands easily!

Command Line

Run the CLI tool using:

acadex <command> [arguments]

Available Commands

Setup & Installation

• acadex setup - First-time full installation
• acadex install:2fa - Install 2FA packages
• acadex install:notif - Install notification feature packages
• acadex check - Check system requirements

Development

• acadex serve - Start production servers (Laravel + Queue + Scheduler + Reverb)
• acadex services - Start background services only (for Herd)
• acadex dev - Start dev servers (Laravel + Queue + Logs + Vite + Reverb)
• acadex build - Build assets for production
• acadex ui - Rebuild UI assets and clear caches
• acadex start - Start Laravel server only

Testing

• acadex test - Run PHPUnit tests
• acadex test:coverage - Run tests with coverage

Database

• acadex migrate - Run database migrations
• acadex migrate:fresh - Fresh migration with seeders
• acadex seed - Run database seeders
• acadex tinker - Start Laravel Tinker

Requirements

• Node.js >= 14.0.0
• Bash shell (Linux/macOS) or PowerShell (Windows)
• PHP and Composer (for Laravel projects)

License

MIT