Skip to content

The fw version Command

Use fw version to display the installed version of the Flywheel CLI.

Usage

1
fw version

Optional Arguments

Optional Argument Description
-h, --help Show help message and exit.
-C PATH, --config-file Specify configuration options via config file.*
--no-config Do NOT load the default configuration file.
-y, --yes Assume the answer is yes to all prompts.
--ca-certs CA_CERTS Path to a local Certificate Authority certificate bundle file. This option may be required when using a private Certificate Authority.
--timezone TIMEZONE Set the effective local timezone to use when uploading data.
-q, --quiet Squelch log messages to the console.
-d, --debug Turn on debug logging.
-v, --verbose Get more detailed output.

* Learn more about how to create this file.

Example

1
fw version

Output:

1
2
flywheel-cli
  version: 20.3.1

When to Use This Command

  • Troubleshooting: When reporting issues to Flywheel support, include your CLI version
  • Compatibility Check: Verify your CLI version is compatible with your Flywheel site
  • Update Verification: Confirm you're running the latest version after updating

Version Compatibility

The Flywheel CLI version should be compatible with your Flywheel site version. If you experience issues:

  1. Check your CLI version:

    1
    fw version

  2. Check your Flywheel site version in the web interface (click the help menu icon in the top-right corner)

  3. If versions are significantly different, update your CLI:

Legacy vs. New CLI

Flywheel maintains two CLI versions:

CLI Command Status Use For
Legacy CLI fw Stable Standard data operations
New CLI fw-beta Beta Bulk operations, gear development, external storage

To check the new CLI version:

1
fw-beta version

See the New CLI documentation for details on beta features.

Understanding Version Numbers

Flywheel uses semantic versioning: MAJOR.MINOR.PATCH

  • MAJOR: Significant changes, may require migration
  • MINOR: New features, backward compatible
  • PATCH: Bug fixes, backward compatible

Example: 20.3.1

  • Major version: 20
  • Minor version: 3
  • Patch version: 1

Scripting with Version

When writing scripts, you can capture the version output:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
#!/bin/bash

# Get CLI version
VERSION=$(fw version | grep "version:" | awk '{print $2}')

echo "Using Flywheel CLI version: $VERSION"

# Check if version meets minimum requirement
REQUIRED="20.0.0"
if [ "$(printf '%s\n' "$REQUIRED" "$VERSION" | sort -V | head -n1)" = "$REQUIRED" ]; then
    echo "CLI version meets requirements"
else
    echo "Please update your CLI to version $REQUIRED or higher"
    exit 1
fi