Skip to main content

A CLI for streamlining workflows for Capture-The-Flag players, including tools for file management and environment interaction.

Project description

ctf_orchestrator

Usage:

$ ctforch [OPTIONS] COMMAND [ARGS]...

Options:

  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • info: Display information about the current...
  • cleanup: Delete non-existing CTFs or challenges...
  • run: Run a command in the current active CTF...
  • challenge: Manage challenges tracked in the active CTF.
  • config: Change configurations used.
  • ctf: Manage CTFs tracked.

ctforch info

Display information about the current stateuration and active CTF.

Usage:

$ ctforch info [OPTIONS]

Options:

  • --help: Show this message and exit.

ctforch cleanup

Delete non-existing CTFs or challenges from the active CTF.

Usage:

$ ctforch cleanup [OPTIONS]

Options:

  • --mode [ctf|chal]: [required]
  • --help: Show this message and exit.

ctforch run

Run a command in the current active CTF directory or active challenge directory.

Usage:

$ ctforch run [OPTIONS] COMMAND_AND_ARGS...

Arguments:

  • COMMAND_AND_ARGS...: The command to execute, followed by its arguments. [required]

Options:

  • --help: Show this message and exit.

ctforch challenge

Manage challenges tracked in the active CTF.

Usage:

$ ctforch challenge [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • add: Add a CTF Challenge to the Active CTF.
  • activate: Activate a CTF challenge in the active CTF
  • deactivate: Deactivate the current active challenge in...
  • solve: Mark a challenge (the active challenge by...

ctforch challenge add

Add a CTF Challenge to the Active CTF.

Usage:

$ ctforch challenge add [OPTIONS] CHAL_NAME CATEGORY

Arguments:

  • CHAL_NAME: [required]
  • CATEGORY: [required]

Options:

  • --points TEXT: [default: 0]
  • --solved TEXT: [default: False]
  • --auto-active TEXT: [default: True]
  • --help: Show this message and exit.

ctforch challenge activate

Activate a CTF challenge in the active CTF

Usage:

$ ctforch challenge activate [OPTIONS] CHAL_NAME

Arguments:

  • CHAL_NAME: [required]

Options:

  • --help: Show this message and exit.

ctforch challenge deactivate

Deactivate the current active challenge in the active CTF

Usage:

$ ctforch challenge deactivate [OPTIONS]

Options:

  • --help: Show this message and exit.

ctforch challenge solve

Mark a challenge (the active challenge by default) in the active CTF as solved.

Usage:

$ ctforch challenge solve [OPTIONS]

Options:

  • --chal-name TEXT
  • --flag TEXT
  • --help: Show this message and exit.

ctforch config

Change configurations used.

Usage:

$ ctforch config [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • setup: Setup the configuration in the /.ctf-orch.'

ctforch config setup

Setup the configuration in the /.ctf-orch.'

Usage:

$ ctforch config setup [OPTIONS]

Options:

  • --help: Show this message and exit.

ctforch ctf

Manage CTFs tracked.

Usage:

$ ctforch ctf [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • init: Initialize a CTF directory.
  • activate: Activate a CTF as the current active CTF.
  • deactivate: Deactivate the current active CTF.

ctforch ctf init

Initialize a CTF directory.

Usage:

$ ctforch ctf init [OPTIONS] CTF_NAME

Arguments:

  • CTF_NAME: [required]

Options:

  • --directory TEXT: [default: C:\Users\user\Desktop\CTF-orchestra]
  • --auto-active TEXT: [default: True]
  • --help: Show this message and exit.

ctforch ctf activate

Activate a CTF as the current active CTF.

Usage:

$ ctforch ctf activate [OPTIONS] CTF_NAME

Arguments:

  • CTF_NAME: [required]

Options:

  • --help: Show this message and exit.

ctforch ctf deactivate

Deactivate the current active CTF.

Usage:

$ ctforch ctf deactivate [OPTIONS]

Options:

  • --help: Show this message and exit.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ctf_orchestrator-0.1.1.tar.gz (7.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ctf_orchestrator-0.1.1-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file ctf_orchestrator-0.1.1.tar.gz.

File metadata

  • Download URL: ctf_orchestrator-0.1.1.tar.gz
  • Upload date:
  • Size: 7.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.0 CPython/3.12.8 Windows/11

File hashes

Hashes for ctf_orchestrator-0.1.1.tar.gz
Algorithm Hash digest
SHA256 745c891f3f129b09b5eda1f7d55e766e0a3367155560680f1119f76868108fe1
MD5 f833844bbc46586299872ad64330620c
BLAKE2b-256 b49262152f857b3575519ceeab37d880beb65d0a52148476d015daa16ce3fa6d

See more details on using hashes here.

File details

Details for the file ctf_orchestrator-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: ctf_orchestrator-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 10.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.0 CPython/3.12.8 Windows/11

File hashes

Hashes for ctf_orchestrator-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d3643a8b5e19f32466127ed88e3ca09c992f50b9da57a822818bc49da17371bb
MD5 776cd63e82f7c61b321845fe97e23e7f
BLAKE2b-256 b83575429154327e59e0be70769551cbad558df7f22cfbc4ab8391c67028f3d1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page