The Flywheel Command-Line Interface (CLI) is a tool for uploading existing data into Flywheel and downloading data from Flywheel to work with offline. The Flywheel CLI is also required to start jobs and build gears. This article explains how to download and install the Flywheel CLI.
This article explains how to update your Flywheel CLI to the latest version. If you haven't installed the Flywheel CLI, see our article to learn how to download and install the Flywheel CLI.
To download the Flywheel CLI:
-
Log in to Flywheel.
-
In the upper-right corner, select your account menu, and select Profile.
-
Go to the Download Flywheel CLI section, and select your computer's operating system.
A zip file with the following name is downloaded to your computer:
-
Linux: fw-linux_amd64.zip
-
OS X: darwin_amd64.zip
-
Windows: fw-windows_amd64.zip
Follow these steps to download the newest version of the Flywheel CLI and replace your older version.
-
Open the Terminal app.
-
Unzip the file.
-
In Terminal, navigate to the Flywheel CLI. For example:
Mac:
cd ~/Downloads/darwin_amd64
Linux:
cd ~/Downloads/fw-linux_amd64
-
(Optional) Enter this command to add the CLI to your PATH:
sudo mv ./fw /usr/local/bin
This makes it easier to access the Flywheel CLI later on. It is not required to add the Flywheel CLI to your PATH. If you do not to add it to your PATH, you must either enter the file path where fw resides in the commands below or run the commands from the same location as the Flywheel CLI.
-
Enter your password when prompted.
-
Open the Command Prompt app.
-
Unzip fw-windows_amd64.
-
(Optional) Enter the following command to add the Flywheel CLI to you PATH:
pathman /rs c:\<pathToYourFlyweehlCLI>
For example:
pathman /rs c:\Programs\fw.exe
This makes it easier to access the Flywheel CLI later on. It is not required to add the Flywheel CLI to your PATH. If you do not to add it to your PATH, you must either enter the file path where fw.exe resides in the commands below or run the commands from the same location as the Flywheel CLI.