Downloading Data with the CLI

Introduction

Sessions, acquisitions, and files can be downloaded using the download command in the Flywheel CLI.

Additional Download Options:

• Use the sync command to download large datasets
• Download a project from the projects page

Usage

fw download [-h] [--config-file CONFIG_FILE | --no-config] [-y] [--ca-certs CA_CERTS] [--timezone TIMEZONE] [--debug | --quiet] [-o [OUTPUT]]  
[-p PREFIX] [-i INCLUDE] [-e EXCLUDE]  
<source-path>

Instruction Steps

Example

Below is an example of how to download a particular subject:

1. Download the Flywheel CLI, and sign in using your API key. Once signed in, the following message should appear:

C02W39YBHTD6:~ AvaAnderson$ fw login staging2.dev.flywheel.io:Ja0ib***********pf
You are now logged in as Ava Anderson!

1. Now you can navigate to the files you wish to download. In this example, we're navigating to the subjects in the AnxietyStudy project:

C02W39YBHTD6:~ AvaAnderson$ fw ls Psychology/AnxietyStudy
admin **s13**
admin **s3**
admin **s5**
admin **s11**
admin **s14**
admin **s15**
admin **s12**
admin Dec5 17:49files/license.txt 

Tip - If a project or subject's name includes spaces, use quotes around the name. For example: Psychology/"An example study"

1. To download one of those subjects:

C02W39YBHTD6:~ AvaAnderson$ fw download Psychology/AnxietyStudy/s3

This download will be about 218 MB comprising 39 files.

Continue? (yes/no): yes
Wrote 218 MB to s3.tar

Reference

Required Flags

Optional Flags

For a full, up-to-date list of options, please run the following from your command line:

fw download --help

Below is a list of commonly used options.