This is an automation framework for machine writeups. It defines a YAML based writeup template that can be used while working on a machine. Once the writeup is complete, the YAML writeup file can be used to render a .md
and .pdf
report alongwith stats and summary for all completed writeups. It works in conjuction with machinescli project, so all machine metadata is natively accessible:
-
Override default writeup directory and GitHub repo URL:
$ svachal -w $HOME/<reponame> -g "https://github.com/<username>/<reponame>
Source the .bash-completion
file within a shell to trigger auto-complete for arguments. This will require the following alias (change path as needed):
alias svachal='python3 $HOME/svachal/svachal.py'
You will need a Nerd Fonts patched font for OS icons and other symbols to be rendered correctly.