Skip to main content

Modern TUI launcher for pentest commands

Project description

Aliasr

PyPI version Python License

Aliasr is a modern, feature-rich TUI launcher for penetration testing commands inspired by Arsenal, but with significantly improved functionality.

Aliasr Quick Guide

Features

Some of the largest improvements Aliasr implements include:

  • Significantly expanded tmux integration.
  • Cheat variations that allow for different authentication methods to be built into a single parameter.
  • Automatic parameter population based on history and other sources.
  • Secure KeePass integration for managing credentials.

Install

# Latest release (PyPI)
uv tool install aliasr
pipx install aliasr

# Latest commit (GitHub)
uv tool install git+https://github.com/Mojo8898/aliasr
pipx install git+https://github.com/Mojo8898/aliasr

I also highly recommend adding the following line to your ~/.zshrc:

alias a=aliasr

If you intend on leveraging the extended tmux integration aliasr offers (which you should), also add the following to your ~/.tmux.conf:

# Add to ~/.tmux.conf
bind U split-window "aliasr send -pp"
bind K split-window "aliasr -e send -pp"

# Recommended tmux settings
set -s escape-time 0
set -s focus-events on
set -s default-terminal "tmux-256color"
set -as terminal-overrides ",*:Tc"

You can now use the prefix+K hotkey to open aliasr below the current pane and send commands automatically to the pane that was focused previously. prefix+U does the same but without also sending the enter key to execute the command.

Usage

$ aliasr -h
usage: aliasr [-h] [-e] {audit,send,scan,list,clear} ...

aliasr - Modern TUI launcher for pentest commands

positional arguments:
  {audit,send,scan,list,clear}
    audit               Audit cheatsheets and configs
    send                Modify how commands are sent
    scan                Auto-populate globals from a target IP
    list                List globals or credentials
    clear               Clear session data

options:
  -h, --help            show this help message and exit
  -e, --exec            Execute the command immediately

Note: Almost all hotkeys can be found in the footer of the application when running.

Configuration

Aliasr allows you to configure pretty much everything. Refer to the built-in config.toml found here to see what configurations options are available. A detailed configuration guide can be found in Configuration.

Create your own config in ~/.config/aliasr/config.toml to edit existing configurations and changes will automatically be merged at runtime.

Cheats

A detailed reference guide on writing cheats can be found here.

Contributing

Contributions are welcome but make sure you if you are contributing to cheats, you follow guidelines in Cheats. Also feel free to open an issue if you want to add other features.

Detailed development setup instructions can be found in the official Textual documentation.

Acknowledgments

  • Inspired by Arsenal by Orange Cyberdefense
  • Built with Textual
  • Special thanks to all members of my HackTheBox team S4U2SelfEnjoyers for beta testing and providing essential feedback.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aliasr-1.0.1.tar.gz (83.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aliasr-1.0.1-py3-none-any.whl (112.7 kB view details)

Uploaded Python 3

File details

Details for the file aliasr-1.0.1.tar.gz.

File metadata

  • Download URL: aliasr-1.0.1.tar.gz
  • Upload date:
  • Size: 83.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for aliasr-1.0.1.tar.gz
Algorithm Hash digest
SHA256 e8ce1bbba4a578fb6cc5096e7d36fc4157445862962de74450d1d999b4e5ea04
MD5 d5a7f2b8819351e5b64699a9053366d4
BLAKE2b-256 2bda82e3095e93dc57d5cee41cf421cdab7360a7b1cb52280ec7b2df2b3006d1

See more details on using hashes here.

Provenance

The following attestation bundles were made for aliasr-1.0.1.tar.gz:

Publisher: publish.yml on Mojo8898/aliasr

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file aliasr-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: aliasr-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 112.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for aliasr-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 860f77f88a1bccf94d445f5b2fbd59cbe0eb25616154f4c25ad6df031d3ea262
MD5 58be958e84e50d16abf6b3c2bc4780be
BLAKE2b-256 6c787c2f5dcd425f01f569e2583a149c2a51a7e1f5678da5d18779fbb0545d09

See more details on using hashes here.

Provenance

The following attestation bundles were made for aliasr-1.0.1-py3-none-any.whl:

Publisher: publish.yml on Mojo8898/aliasr

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page