Supaflow CLI

The Supaflow CLI (@getsupaflow/cli) lets you manage datasources, pipelines, syncs, schedules, and jobs from your terminal. Use it for automation, scripting, and as the foundation for the Claude Code plugin.

Install

npm install -g @getsupaflow/cli

Requires Node.js 18 or later.

Authenticate

1. Log in to app.supa-flow.io and go to Settings > API Keys.
2. Create an API key and copy the value.
3. Run the login command and paste your key when prompted:

supaflow auth login

4. Verify authentication:

supaflow auth status

Select a Workspace

List available workspaces and select one:

supaflow workspaces list
supaflow workspaces select <workspace-name>

The selected workspace persists across commands until you change it.

Run Your First Command

Try these to confirm everything is working:

# Check auth and workspace
supaflow auth status --json

# List available connectors
supaflow connectors list --json

# Browse connector documentation
supaflow docs sqlserver

Command Groups

Command	Description
supaflow auth	Log in, log out, check authentication status
supaflow workspaces	List and select workspaces
supaflow connectors	List available connector types
supaflow datasources	Create, edit, test, and manage datasource connections
supaflow projects	List and create projects
supaflow pipelines	Create, edit, sync, and manage data pipelines
supaflow schedules	Create, edit, and manage recurring sync schedules
supaflow jobs	Check job status, view logs, and inspect results
supaflow encrypt	Encrypt sensitive values for datasource configuration
supaflow docs	Browse connector-specific documentation

Help and Documentation

# Global help
supaflow --help

# Help for a specific command group
supaflow pipelines --help

# Help for a subcommand
supaflow pipelines create --help

# Connector-specific documentation
supaflow docs <connector>
supaflow docs --list

Common Flags

These flags work across most commands:

Flag	Description
--json	Output results as JSON
--workspace <name>	Override the selected workspace for this command

CLI vs Claude Code Plugin

Use case	Recommended tool
Shell scripts and automation	CLI directly
CI/CD pipelines	CLI directly
Guided, interactive workflows	Claude Code plugin
First-time setup with guardrails	Claude Code plugin

The Claude Code plugin uses the CLI under the hood. It adds guardrailed slash commands, parser contracts, and confirmation gates to prevent common AI agent failure modes.

Further Reading

• Full CLI reference on npm
• Claude Code plugin for AI-powered pipeline management