Manage Servers
CommandBox stores information about each of the servers you've ever started inside ~/.CommandBox/servers.json so it can remember settings from one run to the next.

List your server

You can see an overview of your servers and what state they're in with the server list command.
1
server list
2
3
site1 (starting)
4
https://127.0.0.1:8081
5
C:\site1
6
7
site1 (running)
8
https://127.0.0.1:8082
9
C:\site2
10
11
site3 (stopped)
12
https://127.0.0.1:8083
13
C:\site3
Copied!
If you have many servers, you can provide parameters to help filter the results from server list
1
# All servers containing the word "foo"
2
server list foo
3
4
# Running servers
5
server list --running
Copied!
To list only the servers that have been started in a given directory, use the --local flag.
1
server list --local
Copied!
You can take a quick look at the what's been happening with the server log command or use the server status command to see more detailed information including the arguments used previously to start/stop the server.

Multiple Servers

Servers are uniquely identified by their full path, but they also have a short name which defaults to the immediate folder containing their web root. The stop, start, etc commands can be run in the web root for a server, or in any working directory as long as you reference the server's short name.
1
start site1
2
start site2
3
restart site3
4
stop site2
5
stop --all
Copied!
Another handy shortcut is the server cd command that will change the current working directory of the interactive shell to the web root of a named server.
1
server cd site1
2
start
3
server cd site2
4
install myPackage
5
restart
Copied!
Info Server name is the first parameter to all server commands and tab completion works too, making it as easy as possible for you.

Get Server Information

You can get information about a server using the server info command. Add the --JSON flag to get the data back in a JSON format. The property parameter will allow you to retrieve a single value for scripting mashups.
1
server info
2
server info --JSON
3
server info property=serverHomeDirectory
4
server info property=consoleLogPath
Copied!

Forgetting Servers

If you want to wipe all configuration, logs, and WEB-INF files for a server, use the server forget command. This will also remove any administrator settings you may have saved including data sources, mail servers, and server mappings.
1
server forget
Copied!
You can forget all your servers at once too if you want to start with a clean slate. This command will stop and forget all servers.
1
server stop --all --forget
Copied!

Prune Old Servers

You can easily forget all servers which have not been started for a certain period of time with the server prune command. It accepts the number of days that need to have passed since a server was last started in order to prune it.
1
server prune days=30
2
3
# Skip the confirmation check
4
server prune --force
Copied!
You can also get back just a JSON representation of servers matching the filter with the --json flag. The JSON will be in the same format as the server list --json command.
1
server prune 100 --json
Copied!
Last modified 1mo ago