ctf-writeup

Featured

Generates a single standardized submission-style CTF writeup for competition handoff and organizer review. Use after solving a CTF challenge to document the solution steps, tools used, and lessons learned in a structured format.

Code & Development 3,739 stars 446 forks Updated 3 days ago MIT

Install

View on GitHub

Quality Score: 98/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# CTF Write-up Generator Generate a standardized submission-style CTF writeup for a solved challenge. Default behavior: - During an active competition, optimize for speed, clarity, and reproducibility - Keep writeups short enough that a teammate or organizer can validate the solve quickly - Always produce a `submission`-style writeup - Prefer one complete solve script from challenge data to final flag ## Workflow ### Step 1: Gather Information Collect the following from the current session, challenge files, and user input: 1. **Challenge metadata** — name, CTF event, category, difficulty, points, flag format 2. **Solution artifacts** — exploit scripts, payloads, screenshots, command output 3. **Timeline** — key steps taken, dead ends, pivots ```bash # Scan for exploit scripts and artifacts find . -name '*.py' -o -name '*.sh' -o -name 'exploit*' -o -name 'solve*' | head -20 # Check for flags in output files grep -rniE '(flag|ctf|eno|htb|pico)\{' . 2>/dev/null ``` ### Step 2: Generate Write-up Write the writeup file as `writeup.md` (or `writeup-<challenge-name>.md`) using the submission template below. --- ## Templates ### Submission Format ```markdown --- title: "<Challenge Name>" ctf: "<CTF Event Name>" date: YYYY-MM-DD category: web|pwn|crypto|reverse|forensics|osint|malware|misc difficulty: easy|medium|hard points: <number> flag_format: "flag{...}" author: "<your name or team>" --- # <Challenge Name> ## Summary <1-2 sentences: what the challenge was and the...

Details

Author
ljagiello
Repository
ljagiello/ctf-skills
Created
9 months ago
Last Updated
3 days ago
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category