Command Line Client

Download

The ButterflyFX command line client can be downloaded for Windows, Mac, or Linux using the links below.

You can generate your own builds from source by downloading from our code repository.

On Mac and Linux, you’ll also need to copy the downloaded file to your path with the right permissions.

# Replace ~/Downloads with wherever you downloaded the file
cd ~/Downloads
cp butterflyfx /usr/local/bin
chmod +x /usr/local/bin/butterflyfx

Using the command line client

You can use the command line client to create establish a private tunnel between ButterflyFX and your localhost or other internal resources. Once you’ve downloaded the client, you’ll need to generating an API key from the website before making any requests.

butterflyfx --api-key="INSERT-API-KEY-HERE" tunnel

By default, the command line client allows ButterflyFX to access any websites that may be available through your local machine such as local intranet websites. However, you can also restrict access to a specific website by specifying a hostname as an argument to the tunnel command. For example,

butterflyfx --api-key="INSERT-API-KEY-HERE" tunnel localhost:80