wheels plugins install
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 list
to verify installationRestart your application to activate new plugins
Last updated
Was this helpful?