Flywheel CLI - Temporary Storage Location

Introduction

This document explains how the Flywheel CLI chooses its temporary storage location.

The Flywheel CLI will not operate correctly if there is no free space remaining in the storage location.

Instruction Steps

Defaults

The Flywheel CLI is built with the Python programming language and uses Python's gettempdir() function to determine the temporary storage location.

The logic for determining the storage location is explained in the Python 3 Docs for the gettempdir() function. Python searches a standard list of directories to find one in which the calling user can create files. The list is:

1. The directory named by the TMPDIR environment variable.
2. The directory named by the TEMP environment variable.
3. The directory named by the TMP environment variable.
4. A platform-specific location:
   • On Windows, the directories C:\TEMP, C:\TMP, \TEMP, and \TMP, in that order.
   • On all other platforms, the directories /tmp, /var/tmp, and /usr/tmp, in that order.
5. As a last resort, the current working directory.

Overrides

The fw sync command allows the user to change the location to which ZIP archives will be extracted using the --tmp-dir <TMP_PATH> input parameter. Refer to the Optional Arguments section of the fw sync documentation for more details.

Resources

1. Python 3 Docs - gettempdir()
2. fw sync Docs