usefractal

Command line tools for working with Fractal projects and Fractal Cloud.

Quick Start

Run the CLI without installing it globally:

npx usefractal@latest login

Or install it:

npm install -g usefractal
usefractal login

Commands

usefractal login
usefractal whoami
usefractal logout
usefractal deploy
usefractal cloud token
usefractal cloud sql
usefractal cloud storage enable
usefractal cloud storage put <local-file> <remote-path>
usefractal cloud storage get <remote-path> [local-file]
usefractal cloud storage list [prefix]

Use --help at any level:

usefractal --help
usefractal cloud --help
usefractal cloud storage --help

Project Config

Project-aware commands use --project <id>, the nearest frac.json, or FRACTAL_PROJECT_ID, in that order.

usefractal deploy writes frac.json when it creates or attaches a deployment project:

{
  "projectId": "project_123"
}

Cloud

Cloud commands use --env dev|prod or FRACTAL_CLOUD_ENVIRONMENT.

usefractal cloud token --project project_123
usefractal cloud sql --project project_123
usefractal cloud storage list --project project_123

usefractal cloud sql requires psql on PATH unless --print-url is used.