Here's an overview of all the commands available to the CFConfig CLI. There are sub-pages for each of these commands with additional details.

Manage All Configs

cfconfig export

Extracts all configuration from a server to a location of your choice.

cfconfig import

Imports all configuration from a location of your choice into a server. Like export, but spelled different.

cfconfig transfer

Moves all configuration from a location of your choice to another location of your choice. Like import and export but pronounced different.

cfconfig diff

Shows a diff of every setting that's different between two servers or a server and a JSON file.

Manage Individual Configs

cfconfig set

Sets or overwrites a single setting on a server.

cfconfig show

Views a single setting on a server.

Manage Datasources

cfconfig datasource list

List all datasources.

cfconfig datasource save

Add or update a datasource by name

cfconfig datasource delete

Remove a datasource by name.

Manage CF Mappings

cfconfig cfmapping list

List all CF mappings

cfconfig cfmapping save

Add or update a CF mapping by virtual path.

cfconfig cfmapping delete

Remove a CF mapping by virtual path.

Manage Lucee/Railo Caches

cfconfig cache list

List all caches in a Lucee/Railo server.

cfconfig cache save

Add or update a cache by name.

cfconfig cache delete

Remove a cache by name.

Manage Mail Servers

cfconfig mailserver list

List all mail servers on a server.

cfconfig mailserver save

Add or update a mail server by host.

cfconfig mailserver delete

Delete a mail server by host.

Manage Custom Tag Paths

cfconfig customtagpath list

List all Custom Tag paths

cfconfig customtagpath save

Save a Custom Tag path

cfconfig customtagpath delete

Delete a Custom Tag path

Event Gateway Configuration

cfconfig eventgatewayconfig list

List all Event Gateway Configurations

cfconfig eventgatewayconfig save

Add or update an Event Gateway Configuration

cfconfig eventgatewayconfig delete

Delete an Event Gateway Configuration

Event Gateway Instances

cfconfig eventgatewayinstance list

List all Event Gateway Instances

cfconfig eventgatewayinstance save

Add or update an Event Gateway Instance

cfconfig eventgatewayinstance delete

Delete an Event Gateway Instance

Lucee Loggers

cfconfig logger list

List all Lucee Loggers

cfconfig logger save

Add or update a Lucee Logger

cfconfig logger delete

Delete a Lucee Logger

Scheduled Tasks

cfconfig task list

List all Scheduled Tasks

cfconfig task save

Add or update a Scheduled Task

cfconfig task delete

Delete a Scheduled Task

Export configuration from a server. If you don't specify a to, we look for a CommandBox server using the current working directory. Only rely on this if you have a single CommandBox server running in the current directory.

cfconfig export myConfig.json
cfconfig export from=serverNameToExportFrom to=myconfig.json
cfconfig export from=/path/to/server/home to=myconfig.json

All the same rules for engine format and version apply.

cfconfig export to=/path/to/.CFConfig.json from=/path/to/server/home fromFormat=luceeServer@5.1

The version number can be left off toFormat and fromFormat when reading or writing to a CFConfig JSON file or a CommandBox server since we already know the version. If you don't specify a Lucee web or Server context, we default to server. Use a format of "luceeWeb" to switch.

cfconfig export to=myConfig.json fromFormat=luceeWeb

In some situations you might need to alter the data being imported such as with Scheduled Tasks that you might not want to run on the target server. Adding the --pauseTasks flag will import the scheduled tasks in the paused state.

IncludeList and excludeList

You can customize what config settings are transferred with the includeList and excludeList params. If at least one include pattern is provided, only matching settings will be included. Nested keys such as datasources.myDSN or mailservers[1] can be used. You may also use basic wildcards in your pattern. A single * will match any number of chars inside a key name. A double ** will match any number of nested keys.

# Include all settings starting with "event"
cfconfig export to=.CFConfig.json includeList=event*
# Exclude all keys called "password" regardless of what struct they are in
cfconfig export to=.CFConfig.json excludeList=**.password

Append flag

Use the append parameter to merge incoming data with any data already present. For example, if a server already has one datasource defined, and you import a JSON file with 2 more unique datasources, the --append flag will not remove the pre-existing one.

cfconfig export to=.CFConfig.json includeList=datasources --append

JSON Expansion Replacements

If you usually replace sensitive or volatile information in a JSON export with env var expansions like ${DB_PASSWORD}, you can do this automatically my supplying one or more replace mappings. The key is a regular expression to match a key in the format of datasources.myDSN.password and the value is the name of the env var to use. The values will be written to a .env file in the current working directory. You can override this path with the dotenvFile param, or pass an empty string to disable it from being written.

cfconfig export to=.CFConfig.json replace:datasources\.myDSN\.password=DB_PASSWORD

As the value is a regular expression, you can use backreferences like \1 in your env var to make them dynamic. This example would create env vars such as DB_MYDSN_PASSWORD where MYDSN is your actual datasource name.

cfconfig export to=.CFConfig.json replace:datasources\.(.*)\.password=DB_\1_PASSWORD

Any valid regex is possible for some clever replacements. This example would create env vars such as DB_MYDSN_PORT, DB_MYDSN_HOST, and DB_MDSN_DATABASE

cfconfig export to=.CFConfig.json replace:datasources\.(.*)\.(password|class|port|host|database)=DB_\1_\2 dotenvFile=../../settings.properties

To avoid having to pass these replacements every time you transfer your config, you can set then as a global setting for the commandbox-cfconfig module.

# Replace all mail server passwords with ${MAIL_PASSWORD}
config set modules.commandbox-cfconfig.JSONExpansions[mailServers.*.password]=MAIL_PASSWORD
# Dynamically replace with ${DB_MYDSN_password}, ${DB_MYDSN_CLASS}, ${DB_MYDSN_PORT}, etc
config set modules.commandbox-cfconfig.JSONExpansions[datasources\.(.*)\.(password|class|port|host|database)]=DB_\1_\2
# Use default env var name for all settings starting with "requestTimeout" and replace with ${REQUEST_TIMEOUT} and ${REQUEST_TIMEOUT_ENABLED}
config set modules.commandbox-cfconfig.JSONExpansions[requestTimeout.*]=

Import configuration to a server. If you don't specify a to, we look for a CommandBox server using the current working directory. Only rely on this if you have a single CommandBox server running in the current directory.

cfconfig import myConfig.json
cfconfig import to=serverName from=myConfig.json
cfconfig import to=/path/to/server/home from=myConfig.json

All the same rules for engine format and version apply.

cfconfig import from=/path/to/.CFConfig.json to=/path/to/server/home toFormat=luceeServer@5.1

The version number can be left off toFormat and fromFormat when reading or writing to a CFConfig JSON file or a CommandBox server since we already know the version. If you don't specify a Lucee web or Server context, we default to server. Use a format of luceeWeb to switch.

cfconfig import from=myConfig.json toFormat=luceeWeb

IncludeList and excludeList

You can customize what config settings are transferred with the includeList and excludeList params. If at least one include pattern is provided, only matching settings will be included. Nested keys such as datasources.myDSN or mailservers[1] can be used. You may also use basic wildcards in your pattern. A single * will match any number of chars inside a key name. A double ** will match any number of nested keys.

# Include all settings starting with "event"
cfconfig import from=.CFConfig.json includeList=event*
# Exclude all keys called "password" regardless of what struct they are in
cfconfig import from=.CFConfig.json excludeList=**.password

Append flag

Use the append parameter to merge incoming data with any data already present. For example, if a server already has one datasource defined, and you import a JSON file with 2 more unique datasources, the --append flag will not remove the pre-existing one.

cfconfig import from=.CFConfig.json includeList=datasources --append

Transfer configuration from one location/server to another. If you don't specify a from or to, we look for a CommandBox server using the current working directory. Only rely on this if you have a single CommandBox server running in the current directory. You must specify at least a from or a to.

Note the two servers do not need to be the same kind. CFConfig will translate the config for you.

cfconfig transfer from=servername to=anotherServername
cfconfig transfer from=serverName
cfconfig transfer to=serverName
cfconfig transfer from=/path/to/server/home to=/path/to/another/server/home
cfconfig transfer from=/path/to/server/home
cfconfig transfer to=/path/to/server/home

All the same rules for engine format and version apply.

cfconfig transfer from=/path/to/.CFConfig.json to=/path/to/server/home toFormat=luceeServer@5.1

The version number can be left off toFormat and fromFormat when reading or writing to a CFConfig JSON file or a CommandBox server since we already know the version. If you don't specify a Lucee web or Server context, we default to server. Use a format of luceeWeb to switch.

IncludeList and excludeList

You can customize what config settings are transferred with the includeList and excludeList params. If at least one include pattern is provided, only matching settings will be included. Nested keys such as datasources.myDSN or mailservers[1] can be used. You may also use basic wildcards in your pattern. A single * will match any number of chars inside a key name. A double ** will match any number of nested keys.

# Include all settings starting with "event"
cfconfig transfer from=.CFConfig.json includeList=event*
# Exclude all keys called "password" regardless of what struct they are in
cfconfig transfer from=.CFConfig.json excludeList=**.password

Append flag

Use the append parameter to merge incoming data with any data already present. For example, if a server already has one datasource defined, and you import a JSON file with 2 more unique datasources, the --append flag will not remove the pre-existing one.

cfconfig transfer from=.CFConfig.json includeList=datasources --append

JSON Expansion Replacements

If you usually replace sensitive or volatile information in a JSON export with env var expansions like ${DB_PASSWORD}, you can do this automatically my supplying one or more replace mappings. The key is a regular expression to match a key in the format of datasources.myDSN.password and the value is the name of the env var to use. The values will be written to a .env file in the current working directory. You can override this path with the dotenvFile param, or pass an empty string to disable it from being written.

cfconfig transfer to=.CFConfig.json replace:datasources\.myDSN\.password=DB_PASSWORD

As the value is a regular expression, you can use backreferences like \1 in your env var to make them dynamic. This example would create env vars such as DB_MYDSN_PASSWORD where MYDSN is your actual datasource name.

cfconfig tranfser to=.CFConfig.json replace:datasources\.(.*)\.password=DB_\1_PASSWORD

Any valid regex is possible for some clever replacements. This example would create env vars such as DB_MYDSN_PORT, DB_MYDSN_HOST, and DB_MDSN_DATABASE

cfconfig tranfser to=.CFConfig.json replace:datasources\.(.*)\.(password|class|port|host|database)=DB_\1_\2 dotenvFile=../../settings.properties

To avoid having to pass these replacements every time you transfer your config, you can set then as a global setting for the commandbox-cfconfig module.

# Replace all mail server passwords with ${MAIL_PASSWORD}
config set modules.commandbox-cfconfig.JSONExpansions[mailServers.*.password]=MAIL_PASSWORD
# Dynamically replace with ${DB_MYDSN_password}, ${DB_MYDSN_CLASS}, ${DB_MYDSN_PORT}, etc
config set modules.commandbox-cfconfig.JSONExpansions[datasources\.(.*)\.(password|class|port|host|database)]=DB_\1_\2
# Use default env var name for all settings starting with "requestTimeout" and replace with ${REQUEST_TIMEOUT} and ${REQUEST_TIMEOUT_ENABLED}
config set modules.commandbox-cfconfig.JSONExpansions[requestTimeout.*]=

You can diff any two locations, meaning two servers, two JSON files, a server and a JSON file, etc.

cfconfig diff server1 server2
cfconfig diff file1.json file2.json
cfconfig diff servername file.json
cfconfig diff from=path/to/servers1/home to=path/to/server2/home

You can even filter what config settings you see:

cfconfig diff to=serverName --all
cfconfig diff to=serverName --valuesDiffer --toOnly --fromOnly

Diff Reports

The cfconfig diff commandbox has the ability to export HTML and PDF files. The contents of the report will exactly match what displays in the CLI. So any flags you apply such as --toOnly will also filter the report output. This can be handy for historical purposes or just to get the data into a format that's easier to read than the CLI.

To generate an HTML report:

cfconfig diff to=... from=... HTMLReportPath=folder/
cfconfig diff to=... from=... HTMLReportPath=folder/file.html

To generate a PDF report:

cfconfig diff to=... from=... PDFReportPath=folder/
cfconfig diff to=... from=... PDFReportPath=folder/file.pdf

You can generate both HTML and PDF at the same time if you like. If you don't provide a filename, one is created for you with the following format:

cfconfig-diff-report-YYYY-MM-DD-HHMMSS.[html|pdf]

The report directory is also created for you if it doesn't exist.

Remember, you can get funky and generate clever report names on the fly such as:

cfconfig diff ... PDFreportpath="Daily-Report-`#now | #dayOfWeek | #dayOfWeekAsString`.pdf"

This would give you a name like Daily-Report-Thursday.pdf! Existing files are overwritten.

View all configuration

cfconfig show
cfconfig show serverName
cfconfig show /path/to/server/install/home

View a specific configuration setting

cfconfig show requestTimeout
cfconfig show requestTimeout serverName
cfconfig show requestTimeout /path/to/server/install/home adobe@11

Set a configuration setting

Note, this command requires named parameters.

cfconfig set adminPassword=commandbox
cfconfig set adminPassword=commandbox to=serverName
cfconfig set adminPassword=commandbox to=/path/to/server/install/home toFormat=adobe@11

You can actually use CFConfig set to manage the static contents of a JSON export. The JSON file is, after all, just another location you can read from or write to.

# Pull current config from server into JSON file
cfconfig export myConfig.json
# Edit JSON file directly
cfconfig set adminPassword=commandbox to=myConfig.json

Using "deep" property names

The cfconfig set and cfconfig show commands work the same as package set/show in that you can use "deep" keys to access nested properties.

cfconfig show datasources.myDSN
cfconfig show mailServers[1].port
cfconfig set loggers.deploy.level=debug
cfconfig set datasources.myDSN.password=myPass

Keep in mind that examples such as the last line above can create invalid config if you don't already have a datasource called myDSN. If you're needing to create new complex objects, or you're not sure if they will exist, use the other CFConfig namespaces like cfconfig datasource save which will ensure complete settings are saved.

There are three commands to manage datasources.

List all datasources

cfconfig datasource list
cfconfig datasource list from=serverName
cfconfig datasource list from=/path/to/server/home

To receive the data back as JSON, use the --JSON flag.

cfconfig datasource list --JSON

Edit an existing or create a new datasource

Add a new datasource or update an existing datasource. Existing datasources will be matched based on the name. Valid dbdriver options are

• MSSQL -- SQL Server driver

• MSSQL2 -- jTDS driver

• PostgreSql

• Oracle

• Other -- Custom JDBC URL

• MySQL

cfconfig datasource save name=myDSN dbdriver=mysql host=localhost port=3306 database=myDB username=brad password=foobar
cfconfig datasource save name=myDS ... to=serverName
cfconfig datasource save name=myDS ... to=/path/to/server/home

Delete a datasource

Identify the datasource uniquely by the name.

cfconfig datasource delete foo
cfconfig datasource delete foo serverName
cfconfig datasource delete foo /path/to/server/home

There are three commands to manage CF mappings.

List all CF Mappings

cfconfig cfmapping list
cfconfig cfmapping list from=serverName
cfconfig cfmapping list from=/path/to/server/home

To receive the data back as JSON, use the --JSON flag.

cfconfig cfmapping list --JSON

Edit an existing or create a new CF Mapping

Add a new CF mapping or update an existing CF Mapping. Existing mappings will be matched based on the virtual path.

cfconfig cfmapping save /foo C:/foo/bar
cfconfig cfmapping save virtual=/foo physical=C:/foo/bar to=serverName
cfconfig cfmapping save virtual=/foo physical=C:/foo/bar to=/path/to/server/home

Delete a CF Mapping

Identify the mapping uniquely by the virtual path.

cfconfig cfmapping delete /foo
cfconfig cfmapping delete /foo serverName
cfconfig cfmapping delete /foo /path/to/server/home

There are three commands to manage Lucee/Railo caches.

List existing caches

# Lucee server context of the CommandBox server in the current directory
cfconfig cache list

# Lucee web context of the CommandBox server in the current directory
cfconfig cache list fromFormat=luceeWeb

# Target a CommandBox server by name
cfconfig cache list from=serverName

# Target an externally installed server
cfconfig cache list from=/path/to/server/home

To receive the data back as JSON, use the --JSON flag.

cfconfig cache list --JSON

Edit an existing or create a new cache

Add a new cache or update an existing cache. Existing caches will be matched based on the name. You can use a the type parameter as a shortcut for specifying the full Java class, which may change between versions.

cfconfig cache save myCache RAM
cfconfig cache save name=myOtherCache type=EHCache
cfconfig cache save name=myCache type=EHCache  to=serverName
cfconfig cache save name=myCache type=RAM to=/path/to/server/home

Alternatively, specify the full class name.

cfconfig cache save myCache lucee.runtime.cache.ram.RamCache
cfconfig cache save name=myCache class=lucee.runtime.cache.ram.RamCache to=serverName
cfconfig cache save name=myCache class=lucee.runtime.cache.ram.RamCache to=/path/to/server/home

If your cache provider expects custom properties, pass them as additional parameters to this command prefixed with the text custom:. This requires named parameters, of course.

cfconfig cache save name=myCache type=RAM custom:timeToIdleSeconds=0 custom:timeToLiveSeconds=0

Delete an existing cache

Identify the cache uniquely by the name.

cfconfig cache delete myCache
cfconfig cache delete myCache serverName
cfconfig cache delete myCache /path/to/server/home

There are three commands to manage Mail Servers.

List existing mail servers

cfconfig mailserver list
cfconfig mailserver list from=serverName
cfconfig mailserver list from==/path/to/server/home

To receive the data back as JSON, use the --JSON flag.

cfconfig mailserver list --JSON

Edit an existing or create a new mail server

Add a new mail server or update an existing mail server. Existing mail servers will be matched based on the host name.

cfconfig mailserver save smtp.server.com
cfconfig mailserver save smtp=smtp.server.com to=serverName
cfconfig mailserver save smtp=smtp.server.com to=/path/to/server/home

Delete an existing mail server

Identify the mail server uniquely by the host name.

cfconfig mailserver delete /foo
cfconfig mailserver delete /foo serverName
cfconfig mailserver delete /foo /path/to/server/home

Event Gateway Configurations are currently only supported for Adobe ColdFusion. Please contact us if you'd like to sponsor this feature.

List all Event Gateway Configurations

cfconfig eventgatewayconfig list
cfconfig eventgatewayconfig list from=serverName
cfconfig eventgatewayconfig list from=/path/to/server/home

To receive the data back as JSON, use the --JSON flag.

cfconfig eventgatewayconfig list --JSON

Add or update an Event Gateway Configuration

cfconfig eventgatewayconfig save myType "description of gateway" "java.class" 30 true
cfconfig eventgatewayconfig save type=myType description="description of gateway" class="java.class" starttimeout=30 killontimeout=true to=serverName
cfconfig eventgatewayconfig save type=myType description="description of gateway" class="java.class" starttimeout=30 killontimeout=true to=/path/to/server/home

Delete an Event Gateway Configuration

cfconfig eventgatewayconfig delete myType
cfconfig eventgatewayconfig delete myType serverName
cfconfig eventgatewayconfig delete myType /path/to/server/home

Event Gateway Instances are currently only supported for Adobe ColdFusion. Please contact us if you'd like to sponsor this feature.

List all Event Gateway Instances

cfconfig eventgatewayinstance list
cfconfig eventgatewayinstance list from=serverName
cfconfig eventgatewayinstance list from=/path/to/server/home

To receive the data back as JSON, use the --JSON flag.

cfconfig eventgatewayinstance list --JSON

Add or update an Event Gateway Instance

cfconfig eventgatewayinstance save myInstanceId myType "/path1/some.cfc,/path2/code.cfc"
cfconfig eventgatewayinstance save gatewayId=myInstanceId type=myType cfcPaths="/path1/some.cfc,/path2/code.cfc" configurationPath="path3" to=serverName
cfconfig eventgatewayinstance save gatewayId=myInstanceId type=myType cfcPaths="/path1/some.cfc,/path2/code.cfc" configurationPath="path3" to=/path/to/server/home

Delete an Event Gateway Instance

cfconfig eventgatewayinstance delete myInstanceId
cfconfig eventgatewayinstance delete myInstanceId serverName
cfconfig eventgatewayinstance delete myInstanceId /path/to/server/home

List all Lucee Loggers

cfconfig logger list
cfconfig logger list from=serverName
cfconfig logger list from=/path/to/server/home

To receive the data back as JSON, use the --JSON flag.

cfconfig logger list --JSON

Add or update a Lucee Logger

cfconfig logger save name=application appender=resource appenderArguments:path={lucee-config}/logs/application.log
cfconfig logger save name=application appender=resource appenderArguments:path={lucee-config}/logs/application.log to=serverName
cfconfig logger save name=application appender=resource appenderArguments:path={lucee-config}/logs/application.log to=/path/to/server/home

Delete a Lucee Logger

cfconfig logger delete application
cfconfig logger delete application serverName
cfconfig logger delete application /path/to/server/home

Scheduled tasks are supported for both Lucee Server and Adobe ColdFusion. Both engines have some features which are not supported by the other. Check the parameter descriptions in the command help for cfconfig task save for more info.

All CFConfig commands when run against a Lucee server will default to the fromFormat or toFormat to luceeServer. These commands are a notable exception-- since scheduled tasks can only be imported into a Lucee web context, all commands in the cfconfig task namespace will default to the luceeWeb for Lucee servers.

List all Scheduled Tasks

cfconfig task list
cfconfig task list from=serverName
cfconfig task list from=/path/to/server/home

To receive the data back as JSON, use the --JSON flag.

cfconfig task list --JSON

Add or update a Scheduled Task

cfconfig task save myTask http://www.google.com Once 4/13/2018 "5:00 PM"
cfconfig task save task=myTask url=http://www.google.com interval=Once startDate=4/13/2018 startTime="5:00 PM" to=serverName
cfconfig task save task=myTask url=http://www.google.com interval=Once startDate=4/13/2018 startTime="5:00 PM" to=/path/to/server/home

Delete a Scheduled Task

cfconfig task delete myTask
cfconfig task delete myTask serverName
cfconfig task delete myTask /path/to/server/home