ctf-writeup

1# CTF Write-up Generator
2 
3Generate a standardized submission-style CTF writeup for a solved challenge.
4 
5Default behavior:
6 
7- During an active competition, optimize for speed, clarity, and reproducibility
8- Keep writeups short enough that a teammate or organizer can validate the solve quickly
9- Always produce a `submission`-style writeup
10- Prefer one complete solve script from challenge data to final flag
11 
12## Workflow
13 
14### Step 1: Gather Information
15 
16Collect the following from the current session, challenge files, and user input:
17 
181. **Challenge metadata** — name, CTF event, category, difficulty, points, flag format
192. **Solution artifacts** — exploit scripts, payloads, screenshots, command output
203. **Timeline** — key steps taken, dead ends, pivots
21 
22```bash
23# Scan for exploit scripts and artifacts
24find . -name '*.py' -o -name '*.sh' -o -name 'exploit*' -o -name 'solve*' | head -20
25# Check for flags in output files
26grep -rniE '(flag|ctf|eno|htb|pico)\{' . 2>/dev/null
27```
28 
29### Step 2: Generate Write-up
30 
31Write the writeup file as `writeup.md` (or `writeup-<challenge-name>.md`) using the submission template below.
32 
33---
34 
35## Templates
36 
37### Submission Format
38 
39```markdown
40---
41title: "<Challenge Name>"
42ctf: "<CTF Event Name>"
43date: YYYY-MM-DD
44category: web|pwn|crypto|reverse|forensics|osint|malware|misc|ai-ml
45difficulty: easy|medium|hard
46points: <number>
47flag_format: "flag{...}"
48author: "<your name or team>"
49---
50 
51# <Challenge Name>
52 
53## Summary
54…