maride/penretem
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add README

Browse Source
This commit is contained in:
maride 2025-11-23 23:07:33 +01:00
parent 11fe5e95ef
commit 35e7ca67f3
2 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -1 +1,2 @@
.*
*.pdf

17
README.md Normal file
View File

@ -0,0 +1,17 @@
# penretem
_Sounds like passata 'cause it is as delicious_
Penetration Test report template written in [typst](https://typst.app).
- Provides a *Management Summary*, *Test Scope*, *Findings*, and *Appendix* section
- Easy to use, handles the formatting and typesetting hassle for you - as well as all those text you copy-paste anyway
- Supports [CVSS V3.1](https://www.first.org/cvss/v3-1/)
## Usage
Clone this repository and start writing. For a normal, off-the-shelf report, you'll only need to edit the `main.typ` and `findings.typ`.
After that, run `typst compile main.typ`.
The template has some placeholders. They are highlighted in red; to make double-sure that all of them are removed before you submit the report, call `#helper.panicOnPlaceholder.update(true)`. The `typst compile` call will then panic at the first placeholder it finds.