The Flywheel Command Line Interface allows you to interact with the Flywheel system from the command line. Use the CLI to upload & download files, start jobs, and build gears.
To download the Flywheel CLI, navigate to your User Profile by selecting Profile from the drop-down menu in the top right corner of the page, next to the user's picture.
Then, scroll to the Flywheel CLI component and select the button that corresponds with your computer's operating system.
Select a download for your platform. This will contain a zip file with the binary inside.
Unzip the archive, and move the
fw binary somewhere on your path. For example:
sudo mv ./fw /usr/local/bin
Generating your API Key
In order to login to Flywheel using the CLI (or other external client application), you must generate an API key.
After generating, you will now have an API that is a unique authentication token, specific to you and your Flywheel site. You may only have one active API key for a site at a time.
You are now ready to use the CLI to log into your Flywheel site. Open a terminal and type the following command:
fw login "yourapikey"
You will get a confirmation that you logged in as the correct user.