diff --git a/README.md b/README.md index c20052d..4ab6fa7 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ A quick little tool to manage which projects you're on and manage distrobox cont In order to use this tool you'll want to have distrobox set up and have a "template" box you've created that has all yoru tools installed and what not, you'll likely also want to have a folder full of your other custom tools that you get from git hub, this makes it easier. +The distroboxes it sets up will have the prjoect files folder for the project mounted at /pentest and folder you use for custom tools (like the ones you clone from github) at /tools so getting to your files for the project is as easy as `cd /pentest`! + # General Use case and flow I'm not very good at organization. In order to keep track of all the things needed for pentest engagements and keep client data separated from other client data I worte this tool to do it for me. Basically I have a distrobox for each engagement, a folder to keep files related to the engagement, and a separate folder full of my markdown notes for the engagement. An example is below @@ -42,6 +44,12 @@ Current engagements: client1 internal pentest, client 2 internal pentest - attack_notes.md - upcomming - writing +- tools + - bloodhound-linux-x86_64_4.3.1 + - bofhound + - burp_extensions + - ek45 + - etc This tool automatically creates the file structure, and if you use the start_pentest option populates the markdown note files with the templates I use.