Managing rCTF through the CLI

rctf CLI Management Tool

We have written a handy CLI tool to manage your rCTF installation through the CLI.

If you used the automatic installation script, the tool will be placed in /usr/bin/rctf. Otherwise, you can find it at install/rctf.py in the repository.

usage: rctf.py [-h] [--install-path INSTALL_PATH]
               {up,start,down,stop,update,upgrade} ...

Manage rCTF installations from the CLI

Sub-Commands

    up (start)          Start rCTF in background
    down (stop)         Stop rCTF if running
    update (upgrade)    Update the rCTF installation

Starting rCTF

This will bring up your rCTF docker instance.

usage: rctf.py up [-h]

optional arguments:
  -h, --help  show this help message and exit

Example:

# rctf up

Stopping rCTF

This will bring down your rCTF docker instance.

usage: rctf.py down [-h]

optional arguments:
  -h, --help  show this help message and exit

Example:

# rctf down

Updating rCTF

This will git pull in your repository and restart the docker instance if it is running. If it is not running, it will not start it.

usage: rctf.py update [-h]

optional arguments:
  -h, --help  show this help message and exit

Example:

# rctf update

Global Parameters

You can specify these few parameters before the "subcommand".

optional arguments:
  -h, --help            show this help message and exit
  --install-path INSTALL_PATH, --path INSTALL_PATH, -d INSTALL_PATH
                        The path to the rCTF installation to manage