Command Line Interface

The UnrealIRCd CLI (Command Line Interface) allows you to do things from the shell, such as starting or rehashing UnrealIRCd.

To access the tool:
 * On *NIX you go to your UnrealIRCd directory, typically  and there you can run the script:.
 * On Windows you have similar functionality if you open up a cmd.exe window and then  and run:.

If you run the tool without arguments it will print out all possible actions. Or see below for a brief overview of the functionality.

Start/Stop/Restart
On *NIX you can use,   and   to start, stop or restart UnrealIRCd. On Windows this functionality does not exist when in GUI mode, although when running as a windows service you can use  to do the same actions.

Rehashing
You can rehash the server via  on *NIX, or   on Windows.

Status
To see a status report of the server, run  (on *NIX) or   (Windows).

Testing your config
On *NIX you can test if your configuration file has any errors by running:. This is a very useful command to run before you restart UnrealIRCd when you are upgrading.

Hash a password
You can create a password hash via  (*NIX) or   (Windows). See also Authentication types.

Generate cloak keys
If you are creating a configuration file for a new network, it can be helpful to generate random cloak keys. This can be done via  (*NIX) or   (Windows).

Calculate spkifp
When you want to link two servers, usually we use spkifp for authentication, as mentioned in Tutorial: Linking servers (or, see spkifp under Authentication types).

The spkifp of the current server key can be generated via  (*NIX) or   (Windows).

More actions
There are more actions available, just run the tool without arguments and it will print out all the possible actions it can do.