LogoLogo
HomeAPIBlog
3.0.0-SNAPSHOT
3.0.0-SNAPSHOT
  • INTRODUCTION
    • Getting Started
      • Running Local Development Servers
      • Beginner Tutorial: Hello World
      • Beginner Tutorial: Hello Database
      • Tutorial: Wheels, AJAX, and You
    • Frameworks and Wheels
    • Requirements
    • Manual Installation
    • Upgrading
    • Screencasts
  • Command Line Tools
    • CLI Overview
    • Quick Start Guide
    • Command Reference
      • Core Commands
        • wheels init
        • wheels info
        • wheels reload
        • wheels deps
        • wheels destroy
        • wheels watch
      • Code Generation
        • 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
      • Database Commands
        • 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 db schema
        • wheels db seed
      • Testing Commands
        • wheels test
        • wheels test run
        • wheels test coverage
        • wheels test debug
      • Configuration Commands
        • wheels config list
        • wheels config set
        • wheels config env
      • Environment Management
        • wheels env
        • wheels env setup
        • wheels env list
        • wheels env switch
      • Plugin Management
        • wheels plugins
        • wheels plugins list
        • wheels plugins install
        • wheels plugins remove
      • Code Analysis
        • wheels analyze
        • wheels analyze code
        • wheels analyze performance
        • wheels analyze security
      • Security Commands
        • wheels security
        • wheels security scan
      • Performance Commands
        • wheels optimize
        • wheels optimize performance
      • Documentation Commands
        • wheels docs
        • wheels docs generate
        • wheels docs serve
      • CI/CD Commands
        • wheels ci init
      • Docker Commands
        • wheels docker init
        • wheels docker deploy
      • Deployment Commands
        • 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
    • CLI Development Guides
      • Creating Commands
      • Service Architecture
      • Migrations Guide
      • Testing Guide
  • Working with Wheels
    • Conventions
    • Configuration and Defaults
    • Directory Structure
    • Switching Environments
    • Testing Your Application
    • Using the Test Environment
    • Contributing to Wheels
    • Submitting Pull Requests
    • Documenting your Code
  • Handling Requests with Controllers
    • Request Handling
    • Rendering Content
    • Redirecting Users
    • Sending Files
    • Sending Email
    • Responding with Multiple Formats
    • Using the Flash
    • Using Filters
    • Verification
    • Event Handlers
    • Routing
    • URL Rewriting
      • Apache
      • IIS
      • Tomcat
      • Nginx
    • Obfuscating URLs
    • Caching
    • Nesting Controllers
    • CORS Requests
  • Displaying Views to Users
    • Pages
    • Partials
    • Linking Pages
    • Layouts
    • Form Helpers and Showing Errors
    • Displaying Links for Pagination
    • Date, Media, and Text Helpers
    • Creating Custom View Helpers
    • Localization
  • Database Interaction Through Models
    • 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
    • Database Migrations
      • Migrations in Production
    • Using Multiple Data Sources
  • Plugins
    • Installing and Using Plugins
    • Developing Plugins
    • Publishing Plugins
  • Project Documentation
    • Overview
  • External Links
    • Source Code
    • Issue Tracker
    • Sponsor Us
    • Community
Powered by GitBook
LogoLogo
On this page
  • Usage
  • Parameters
  • Description
  • Examples
  • Basic plugin removal
  • Remove without backup
  • Force removal (ignore dependencies)
  • Remove multiple plugins
  • Removal Process
  • Output
  • Dependency Handling
  • Backup Management
  • Restore from backup
  • Notes

Was this helpful?

Edit on GitHub
Export as PDF
  1. Command Line Tools
  2. Command Reference
  3. Plugin Management

wheels plugins remove

Removes an installed plugin from your CFWheels application.

Usage

wheels plugins remove <plugin> [--backup] [--force]

Parameters

  • plugin - (Required) Name of the plugin to remove

  • --backup - (Optional) Create a backup before removal. Default: true

  • --force - (Optional) Force removal even if other plugins depend on it

Description

The plugins remove command safely uninstalls a plugin from your CFWheels application. It:

  • Checks for dependent plugins

  • Creates a backup (by default)

  • Removes plugin files

  • Cleans up configuration

  • Updates plugin registry

Examples

Basic plugin removal

wheels plugins remove authentication

Remove without backup

wheels plugins remove cache-manager --no-backup

Force removal (ignore dependencies)

wheels plugins remove routing --force

Remove multiple plugins

wheels plugins remove plugin1
wheels plugins remove plugin2

Removal Process

  1. Dependency Check: Ensures no other plugins depend on this one

  2. Backup Creation: Saves plugin files to backup directory

  3. Deactivation: Disables plugin in application

  4. File Removal: Deletes plugin files and directories

  5. Cleanup: Removes configuration entries

  6. Verification: Confirms successful removal

Output

Removing plugin: authentication
================================

Checking dependencies... ✓
Creating backup at /backups/plugins/authentication-2.1.0-20240115.zip... ✓
Deactivating plugin... ✓
Removing plugin files... ✓
Cleaning configuration... ✓

Plugin 'authentication' removed successfully!

Note: Backup saved to /backups/plugins/authentication-2.1.0-20240115.zip
      You may need to restart your application.

Dependency Handling

If other plugins depend on the one being removed:

Cannot remove plugin: routing
=============================

The following plugins depend on 'routing':
- advanced-routing (v1.2.0)
- api-framework (v3.0.1)

Options:
1. Remove dependent plugins first
2. Use --force to remove anyway (may break functionality)

Backup Management

Backups are stored in /backups/plugins/ with timestamp:

  • Format: [plugin-name]-[version]-[timestamp].zip

  • Example: authentication-2.1.0-20240115143022.zip

Restore from backup

# Manually restore a plugin
wheels plugins install /backups/plugins/authentication-2.1.0-20240115.zip

Notes

  • Always restart your application after removing plugins

  • Backups are kept for 30 days by default

  • Some plugins may leave configuration files that need manual cleanup

  • Database tables created by plugins are not automatically removed

  • Use wheels plugins list to verify removal

Previouswheels plugins installNextCode Analysis

Last updated 2 days ago

Was this helpful?