FlexSite CLI Reference

Applies to: FlexLab

Overview

The FlexSite CLI (flexsite) automates database pulls, file sync, Drush, and auth against FlexLab environments.

Prerequisites

  • FlexLab project with at least one ready environment.
  • Personal access token from Profile → Tokens (account menu).
  • CLI installed locally (npm install -g @flexsite/cli or per docs).

Common commands

CommandPurpose
flexsite auth loginAuthenticate with token
flexsite auth statusVerify session
flexsite db pullDownload latest DB backup
flexsite files pullDownload files backup
flexsite syncSync DB and files
flexsite drush -- Run Drush remotely

Steps — first use

  1. Create token with required scopes on Tokens.
  2. Run flexsite auth login in your project directory.
  3. Select organization and environment when prompted.
  4. Run flexsite db pull to test connectivity.

See FlexSite CLI Setup in the FlexLab book for full command reference.