Skip to content

Challenge

challenge

Generate and test your challenge

Usage:

challenge [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

challenge add

: Import a challenge with its URL (must be a GIT repo)

:param challenge_url: The URL of the challenge to import :type challenge_url: str

Usage:

challenge add [OPTIONS] CHALLENGE_URL

Options:

  --help  Show this message and exit.

challenge new

: Creates a CTF Kit challenge repo for a new challenge

:param challenge_name: The name of the challenge to create :type challenge_name: str

Usage:

challenge new [OPTIONS] CHALLENGE_NAME

Options:

  --help  Show this message and exit.

challenge run

Run a challenge inside a Docker container. For the moment this method doesn't add any specific parameters to the container (such as port) but it will when a challenge object will be available. First a Docker image is built using the Dockerfile located in the challenge's directory and then we run a Docker container with the built image.

:param challenge: The name of the challenge to run

Usage:

challenge run [OPTIONS] CHALLENGE

Options:

  --help  Show this message and exit.

challenge stop

Stop a challenge running inside a Docker container. First we stop the container using his name, then we delete the related Docker image.

:param challenge: The name of the running challenge.

Usage:

challenge stop [OPTIONS] CHALLENGE

Options:

  --help  Show this message and exit.