CFConfig Documentation
  • Introduction
  • The Basics
    • About This Book
    • Authors
    • Overview
    • Getting Started Guide
    • Supported Engines
    • Config Items
  • Using the CLI
    • Installation
    • Usage
    • CommandBox Server Interceptors
      • Server Start
      • Server Stop
    • Command Overview
      • Export Settings
      • Import Settings
      • Transfer Settings
      • Diff Settings
      • Set/View Settings
      • Manage Datasources
      • Manage CF Mappings
      • Manage Caches
      • Manage Mail Servers
      • Manage Event Gateway Configuration
      • Manage Event Gateway Instances
      • Manage Lucee Loggers
      • Manage Scheduled Tasks
    • JSON File Storage
    • Env Var Overrides
  • Using the Services
    • Installation
    • Component Overview
    • API Overview
Powered by GitBook
On this page
  • Requirements
  • Updating CFConfig

Was this helpful?

Edit on GitHub
Export as PDF
  1. Using the CLI

Installation

PreviousConfig ItemsNextUsage

Last updated 9 months ago

Was this helpful?

The CFConfig CLI lives on ForgeBox and can be installed into CommandBox with the following command:

CommandBox> install commandbox-cfconfig

If you do not have CommandBox installed, have no fear! CommandBox is a single binary that will run on Mac, Linux, or Windows. Please visit our CommandBox docs and you'll have it installed in a jiffy.

Requirements

The only requirement for the CFConfig CLI is 3.6.0 or higher.

Updating CFConfig

CFConfig is under active development and changing on a regular basis. To make sure you have the latest version installed, you can simply cd into the CFML home directory of your CommandBox install and use the regular package update command. This will pull in minor and patch updates but not major version changes.

update --system

If you have a pre-release version of CFConfig or need to upgrade to a new major version, use this command:

install commandbox-cfconfig --force
https://commandbox.ortusbooks.com/setup/installation
CommandBox