Skip to content

First steps with PS Banshee

After installing PS Banshee, you can check that the commands are available by running the banshee command:

PS Banshee commands

You should see a help menu listing the available commands.

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.

Current shell only:

1
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):

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

Current session only:

1
$env:RF_TOKEN = '<your_api_key>'

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

1
setx RF_TOKEN <your_api_key>

Current session only:

1
set RF_TOKEN=<your_api_key>

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

1
setx RF_TOKEN <your_api_key>

Option 2: Pass with -k per command

1
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.

Proxies

If you are behind a proxy, set the HTTP_PROXY and HTTPS_PROXY environment variables.

To disable SSL verification, use the -s flag:

1
banshee -s ca rules

Next steps

Now that you've confirmed PS Banshee is installed jump to the commands reference to start using PS Banshee, and learn how to get help if you run into any issues.