4 The Settings File
Bee edited this page 2020-09-08 03:29:58 +01:00
This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

The settings file contains settings for Ciphey. Specifically, some of these you may want:

  • Regex list. Have a list of Regexs for the Regex checker? Use the settings file.
  • Default language. Hate how Ciphey always loads in English? Use the settings file to change the default language to whatever you want.
  • Is the language checker not working how you want it to work? Fine-tune the details in the settings file.

Default Settings File

Save this as settings.yml in the appdirs location, which can be found by running ciphey -where or where.

➜ python3 ciphey -where
settings.yml should be placed in /home/bee/.config/ciphey

From this example, we can see that using the argument we need to place the settings file at /home/bee.config/ciphey/settings.yml

The settings file follows a specific format. Copy and paste this below!

---
params:
  regex:
    regex:
    - FLAG{*.}
    - CTF{*.}
    - HTB{*.}
    - THM{*.}
  brandon:
    top1000: cipheydists::list::english1000
    wordlist: cipheydists::list::english
    stopwords: cipheydists::list::englishStopWords
    threshold: 0.45