#TryHackMe README.md Generator: Effortless Setup for CTFs

Before starting a Capture The Flag challenge on TryHackMe, I kept doing the same small setup: create a directory, add a README, copy over the questions, then finally begin the room.

The TryHackMe Auto README.md Generator is the Python script I wrote to skip that first part.

#What it does

Given a TryHackMe room, the script fetches its details and tasks, creates the local structure, and fills in a README.

It can generate either a small file with the room questions or a larger template with sections for common scans and enumeration.

#How It Works

The script reads two command-line flags:

for arg in sys.argv:
    if arg == "-r":
        room = thm.room_details(sys.argv[(sys.argv.index(arg) + 1)])
        room_questions = thm.room_tasks(sys.argv[(sys.argv.index(arg) + 1)])
    if arg == "-A":
        full_readme = True

In this snippet, -r selects the room and fetches its details and tasks. -A enables the larger template, which adds predefined sections for common scans and enumeration.

#Usage

The basic and expanded forms are:

1. Basic README: python autoreadme.py -r vulnversity
2. Advanced README: python autoreadme.py -r vulnversity -A

The script creates the directory and populates the README with the room questions and, when requested, the extra sections.

#Why it exists

This is not a sophisticated tool. It automates a few minutes of work I was repeating before every room, which means a little more time solving the challenge and a little less time preparing to solve it.