Installing PS Banshee

Installation methods

Install ps-banshee with pipx or pip.

Installation

PS Banshee requires Python 3.10 or later (up to 3.13).

Recommended: pipx (isolated environment)

To install globally, run:

pipx install ps-banshee

Installing pipx

If you don't have pipx installed, see the installation guide.

Alternative: pip (current environment)

To install in the current environment, run:

pip install ps-banshee

Dependencies

All required Python dependencies are resolved automatically by pip.
To use the pcap command, ensure you have:

• tshark 3.0.0 or later

Authorization

PS Banshee reads your Recorded Future API key from the RF_TOKEN environment variable (recommended) or from the -k / --api-key flag on each command.

Option 1: Set RF_TOKEN (recommended)

macOS / LinuxWindows (PowerShell)Windows (Command Prompt)

Current shell only:

export RF_TOKEN=<your_api_key>

Persist for future shells (zsh — adjust to ~/.bashrc for bash). Open a new shell after running this (or run source ~/.zshrc to apply in the current shell):

echo 'export RF_TOKEN=<your_api_key>' >> ~/.zshrc

Current session only:

$env:RF_TOKEN = '<your_api_key>'

Persist for future sessions (open a new PowerShell after running this):

setx RF_TOKEN <your_api_key>

Current session only:

set RF_TOKEN=<your_api_key>

Persist for future sessions (open a new Command Prompt after running this):

setx RF_TOKEN <your_api_key>

Option 2: Pass with -k per command

banshee -k <your_api_key> <command> <sub-command> <arguments>

This works on any platform, but is more verbose and the key may land in shell history.

Upgrading PS Banshee

To upgrade PS Banshee to a newer version, reinstall using the updated wheel file.

Upgrading from v1.0.0 or earlier

If you are upgrading from v1.0.0 or an earlier version, you must uninstall the existing package first before installing the new version.

If installed with pipx:

pipx uninstall banshee 
pipx install ps-banshee

If installed with pip:

pip uninstall banshee
pip install ps-banshee

If installed with pipx:

pipx install --force ps-banshee

If installed with pip:

pip install --upgrade ps-banshee

Shell autocompletion

After installing PS Banshee, enable command auto completion with:

banshee --install-completion

Restart your shell to complete the installation. You can now use TAB to auto-complete commands.

Uninstallation

To remove PS Banshee from your system, use the appropriate command based on your installation method.

If installed with pipx:

pipx uninstall ps-banshee

If installed with pip:

pip uninstall ps-banshee

Next steps

See the first steps to start using PS Banshee.