CLI Overview
Quick Start Guide
wheels info
wheels reload
wheels deps
wheels destroy
wheels watch
wheels generate app
wheels generate app-wizard
wheels generate controller
wheels generate model
wheels generate view
wheels generate property
wheels generate route
wheels generate resource
wheels generate api-resource
wheels generate frontend
wheels generate test
wheels generate snippets
wheels scaffold
wheels db create
wheels db drop
wheels db setup
wheels db reset
wheels db status
wheels db version
wheels db rollback
wheels db seed
wheels db dump
wheels db restore
wheels db shell
wheels db schema
wheels dbmigrate info
wheels dbmigrate latest
wheels dbmigrate up
wheels dbmigrate down
wheels dbmigrate reset
wheels dbmigrate exec
wheels dbmigrate create blank
wheels dbmigrate create table
wheels dbmigrate create column
wheels dbmigrate remove table
wheels test
wheels test run
wheels test coverage
wheels test debug
wheels config list
wheels config set
wheels config env
wheels env
wheels env setup
wheels env list
wheels env switch
wheels environment
wheels console
wheels runner
wheels server
wheels server start
wheels server stop
wheels server restart
wheels server status
wheels server log
wheels server open
wheels plugins
wheels plugins list
wheels plugins install
wheels plugins remove
wheels analyze
wheels analyze code
wheels analyze performance
wheels analyze security
wheels security
wheels security scan
wheels optimize
wheels optimize performance
wheels docs
wheels docs generate
wheels docs serve
wheels ci init
wheels docker init
wheels docker deploy
wheels deploy
wheels deploy audit
wheels deploy exec
wheels deploy hooks
wheels deploy init
wheels deploy lock
wheels deploy logs
wheels deploy proxy
wheels deploy push
wheels deploy rollback
wheels deploy secrets
wheels deploy setup
wheels deploy status
wheels deploy stop
Configuration Management
Creating Commands
Service Architecture
Migrations Guide
Testing Guide
Object Relational Mapping
Creating Records
Reading Records
Updating Records
Deleting Records
Column Statistics
Dynamic Finders
Getting Paginated Data
Associations
Nested Properties
Object Validation
Object Callbacks
Calculated Properties
Transactions
Dirty Records
Soft Delete
Automatic Time Stamps
Using Multiple Data Sources
plugins install (coming Soon)
This command may not work as expected. A complete and stable version is coming soon.
Installs a Wheels CLI plugin from various sources including ForgeBox, GitHub, or local files.
Usage
wheels plugins install <name> [--dev] [--global] [--version=<version>]
Parameters
name- (Required) Plugin name or repository URL--dev- (Optional) Install as development dependency--global- (Optional) Install globally--version- (Optional) Specific version to install
Description
The plugins install command downloads and installs Wheels plugins into your application. It supports multiple installation sources:
- ForgeBox Registry: Official and community plugins
- GitHub Repositories: Direct installation from GitHub
- Local Files: ZIP files or directories
- URL Downloads: Direct ZIP file URLs
The command automatically:
- Checks plugin compatibility
- Resolves dependencies
- Backs up existing plugins
- Runs installation scripts
Examples
Install from ForgeBox
wheels plugins install wheels-vue-cli
Install specific version
wheels plugins install wheels-docker --version=2.0.0
Install from GitHub
wheels plugins install https://github.com/user/wheels-plugin
Install as development dependency
wheels plugins install wheels-docker --dev
Install globally
wheels plugins install wheels-cli-tools --global
Install with multiple options
wheels plugins install wheels-testing --dev --version=1.5.0
Installation Process
- Download: Fetches plugin from specified source
- Validation: Checks compatibility and requirements
- Backup: Creates backup of existing plugin (if any)
- Installation: Extracts files to plugins directory
- Dependencies: Installs required dependencies
- Initialization: Runs plugin setup scripts
- Verification: Confirms successful installation
Output
📦 Installing plugin: wheels-vue-cli...
✅ Plugin installed successfully
If installation fails:
📦 Installing plugin: invalid-plugin...
❌ Plugin installation failed
Error: Plugin not found in repository
Plugin Sources
ForgeBox
# Install by name (searches ForgeBox)
wheels plugins install plugin-name
# Install specific ForgeBox ID
wheels plugins install forgebox:plugin-slug
GitHub
# HTTPS URL
wheels plugins install https://github.com/user/repo
# GitHub shorthand
wheels plugins install github:user/repo
# Specific branch/tag
wheels plugins install github:user/repo#v2.0.0
Direct URL
wheels plugins install https://example.com/plugin.zip
Notes
- Plugins must be compatible with your Wheels version
- Always backup your application before installing plugins
- Some plugins require manual configuration after installation
- Use
wheels plugins listto verify installation - Restart your application to activate new plugins