ctf-writeup-generator_skill

Overview

This skill automatically generates professional CTF writeups from solving sessions, detecting flags, categorizing challenges, and producing well-structured Markdown. It is designed for CTF players, security researchers, and instructors who want polished documentation, reproducible steps, and exportable outputs for portfolios or training.

How this skill works

Provide challenge metadata and your solving notes or let the skill infer category and difficulty from descriptions and commands. The skill extracts flags using common and custom regex patterns, validates formats, identifies tools and attack phases, and assembles a complete Markdown writeup with syntax-highlighted code blocks. It can apply platform-specific templates (HackTheBox, TryHackMe, OffSec, etc.) and export to Markdown, PDF, or HTML.

When to use it

• You finished a challenge and need a professional writeup for a portfolio or report
• You want to convert raw solving notes and command history into structured documentation
• You need to extract and validate flags from messy notes or logs
• You want platform-specific formatting (HTB, TryHackMe, OffSec) automatically applied
• You are preparing teaching materials or tutorials from CTF solutions

Best practices

• Provide detailed solving notes, command outputs, and any dead-end attempts for richer writeups
• Specify platform and flag format if non-standard to ensure accurate validation
• Sanitize sensitive data (credentials, API keys) before sharing notes
• Choose a writeup style (tutorial, speedrun, academic) to control depth and tone
• Include screenshots or attachments separately if you want them embedded in the final export

Example use cases

• Generate a HackTheBox machine report with separate user/root sections and an attack path
• Create a Jeopardy-style challenge writeup that highlights point value, category, and steps
• Produce a tutorial-style document for a web exploit with Burp Suite and SQLMap commands
• Build a portfolio-ready Markdown file for a reverse engineering or binary exploit
• Export a class exercise writeup to PDF for distribution in a training session