Get started with the CLI

Install the FlashDrive CLI, select a drive, and open it as a folder on your computer. You need Python 3.10 or later and a FlashDrive account.

1. Install

Check the current release information first. For an automated request, send Flashdrive-Client: flashdrive-cli/1.0.0. Require schema flashdrive-releases.v1, API major 1, a stable cli.latest_version, package flashdrive-cli, and an artifact for your operating system and architecture. If the version is null or the artifact is missing, the CLI is not available for that platform. Use the Console or MCP meanwhile.

Use the advertised cli.install command. The examples below apply only when release information confirms availability.

Install pipx  or uv  first if you do not already use either tool. Choose one of the following installation methods.

Use pipx to install the CLI in its own environment:

pipx install flashdrive-cli
flashdrive --version

Or use uv instead of pipx:

uv tool install flashdrive-cli
flashdrive --version

uv installs the CLI without pip. pipx installs with pip: after installing, check pipx runpip --skip-maintenance flashdrive-cli --version reports 26.2.2 or later, and follow the pip guidance in the SDK installation guide if it does not. The package is flashdrive-cli; the command you run is flashdrive. If the command is not found, open a new terminal and check that your installer’s executable directory is on your PATH.

2. Sign in

Create your account in the Console, then run:

flashdrive login
flashdrive whoami

Your browser opens for sign-in. Check the verification code against your terminal and finish signing in. The terminal reports your account when the connection is ready.

3. Choose a workspace and drive

flashdrive workspace list
flashdrive workspace use WORKSPACE_ID
flashdrive drive list
flashdrive drive use DRIVE_ID

Replace WORKSPACE_ID and DRIVE_ID with IDs from the preceding lists. The CLI saves these choices for later commands. To create a drive in the selected workspace, run flashdrive drive create "Research", then select its returned ID. Creating a drive requires the corresponding permission and available account capacity.

4. Work with your files

On macOS or Linux, mount the drive:

flashdrive mount --at ~/FlashDrive/research
flashdrive mounts

Open that folder in your editor or file manager. The CLI synchronizes edits with the drive. Check flashdrive mounts for unsaved changes, then unmount when finished.

For an individual file, upload and check its status:

flashdrive upload ./handbook.txt --wait
flashdrive file list

A successful upload confirms durable storage. Search readiness is reported separately. Next, search your files, read or edit a file, or configure another profile.