Arsenal is just a quick inventory, reminder and launcher for pentest commands.
This project written by pentesters for pentesters simplify the use of all the hard-to-remember commands
In arsenal you can search for a command, select one and it’s prefilled directly in your terminal. This functionality is independent of the shell used. Indeed arsenal emulates real user input (with TTY arguments and IOCTL) so arsenal works with all shells and your commands will be in the history.
You have to enter arguments if needed, but arsenal supports global variables.
For example, during a pentest we can set the variable
ip to prefill all commands using an ip with the right one.
To do that you just have to enter the following command in arsenal:
This project is inspired by navi (https://github.com/denisidoro/navi) because the original version was in bash and too hard to understand to add features
Arsenal new features
- New colors
- Add tmux new pane support (with -t)
- Add default values in cheatsheets commands with
- Support description inside cheatsheets
- New categories and Tags
- New cheatsheets
- Add yml support (thx @0xswitch )
- Add fzf support with ctrl+t (thx @mgp25)
Install & Launch
python3 -m pip install arsenal-cli
- run (we also advice you to add this alias :
git clone https://github.com/Orange-Cyberdefense/arsenal.git
python3 -m pip install -r requirements.txt
Inside your .bashrc or .zshrc add the path to
run to help you do that you could launch the addalias.sh script
- Also if you are an Arch user you can install from the AUR:
git clone https://aur.archlinux.org/arsenal.git
- Or with an AUR helper like yay:
Launch in tmux mode
./run -t # if you launch arsenal in a tmux window with one pane, it will split the window and send the command to the otherpane without quitting arsenal
# if the window is already splited the command will be send to the other pane without quitting arsenal
./run -t -e # just like the -t mode but with direct execution in the other pane without quitting arsenal
Add external cheatsheets
You could add your own cheatsheets insode the my_cheats folder or in the ~/.cheats folder.
You could also add additional paths to the file
, arsenal reads
.md (MarkDown) and
If you got on error on color init try :
If you have the following exception when running Arsenal:
ImportError: cannot import name 'FullLoader'
First, check that requirements are installed:
pip install -r requirements.txt
If the exception is still there: