Skip to content

estuary/agent-skills / skills/estuary-flowctl-setup

estuary-flowctl-setup

Verified

Install and authenticate the flowctl CLI for Estuary. Use when setting up flowctl for the first time, troubleshooting authentication, upgrading to the latest version, or configuring programmatic access for CI/CD. Use when user says "install flowctl", "set up flowctl", "flowctl auth", "how to authenticate", "token expired", "not authenticated", "FLOW_AUTH_TOKEN", "CI/CD setup", "programmatic access", "upgrade flowctl", "flowctl not found", "command not found flowctl", "Exec format error", or "flowctl on Windows".

flowctl Setup — Install, Authenticate, and Update

flowctl is Estuary's CLI for managing captures, materializations, collections, and derivations from the command line.

Install

Mac (Homebrew — recommended)

brew tap estuary/flowctl
brew install flowctl

Mac (direct download)

sudo curl -o /usr/local/bin/flowctl -L 'https://github.com/estuary/flow/releases/latest/download/flowctl-multiarch-macos' && sudo chmod +x /usr/local/bin/flowctl

Linux (x86-64)

sudo curl -o /usr/local/bin/flowctl -L 'https://github.com/estuary/flow/releases/latest/download/flowctl-x86_64-linux' && sudo chmod +x /usr/local/bin/flowctl

Windows

No native Windows build exists. Use one of:

  1. WSL (recommended) — Install Windows Subsystem for Linux, then use the Linux install command above inside your WSL shell.
  2. Remote dev environment — Run flowctl on a cloud Linux VM and connect via your IDE's remote development features.

Note: On ARM-based Windows machines (e.g., Snapdragon/aarch64 under WSL), the x86-64 binary won't work (Exec format error). There is no official ARM build yet — use a remote x86-64 environment or build from source.

Authenticate

Interactive login (local development)

flowctl auth login

This opens your browser to the Estuary dashboard's CLI-API tab. Copy the access token and paste it into the terminal.

Note: Access tokens are short-lived (~1 hour). You'll need to repeat this when the token expires.

Programmatic access (CI/CD and automation)

For non-interactive environments, use a long-lived refresh token:

  1. Go to https://dashboard.estuary.dev/admin/api and generate a refresh token
  2. Set the environment variable:
    export FLOW_AUTH_TOKEN=<your-refresh-token>
    
  3. Run flowctl commands normally — authentication is handled automatically

Important: If a config file exists for the current profile, flowctl ignores FLOW_AUTH_TOKEN. Use a separate profile to avoid conflicts:

flowctl --profile ci catalog list

The refresh token expires after 90 days of inactivity — each use resets the clock.

Common CI mistake: Don't run flowctl auth token --token $FLOW_AUTH_TOKEN in your scripts — that command is for interactive token exchange only. Just set the env var and run flowctl commands directly.

Verify Installation

flowctl --version

Quick test that authentication works:

flowctl catalog list --output json | head -5

Update

Homebrew

brew update && brew upgrade flowctl

Direct download

Re-run the install command for your platform — it overwrites the existing binary.

Troubleshooting

ProblemSolution
command not found: flowctlRe-run the install command, or check that /usr/local/bin is in your PATH
You are not authenticatedRun flowctl auth login — your token likely expired
Exec format errorWrong binary for your architecture — ARM machines need an x86-64 environment (see Windows section)
FLOW_AUTH_TOKEN ignoredAn existing profile config takes precedence — use flowctl --profile ci <command>
Header of type authorization was missingToken didn't save correctly — re-run flowctl auth login and paste carefully
Failed to locate sopsOnly needed for local secret encryption — install sops if using encrypted configs

Check for the latest releases and changelogs: https://github.com/estuary/flow/releases

Related Skills

  • estuary-logs — Search and analyze task logs with flowctl
  • estuary-catalog-status — Check whether tasks are running, disabled, or failed
  • estuary-connector-restart — Pause and restart connectors via flowctl
writing-skillsobra/superpowersUse when creating new skills, editing existing skills, or verifying skills work before deploymentStars: 321kUpdated Claude CodeCodexVerifiedInstall
xlsxanthropics/skillsUse this skill any time a spreadsheet file is the primary input or output. This means any task where the user wants to: open, read, edit, or fix an existing .xlsx, .xlsm, .xltx, .csv, or .tsv file (e.g., adding columns, computing formulas, formatting, charting, cleaning messy data); create a new spreadsheet from scratch or from other data sources; or convert between tabular file formats. Trigger especially when the user references a spreadsheet file by name or path — even casually (like "the xlsx in my downloads") — and wants something done to it or produced from it. Also trigger for cleaning or restructuring messy tabular data files (malformed rows, misplaced headers, junk data) into proper spreadsheets. The deliverable must be a spreadsheet file. Do NOT trigger when the primary deliverable is a Word document, HTML report, standalone Python script, database pipeline, or Google Sheets API integration, even if tabular data is involved.Stars: 197kUpdated Claude CodeCodexVerifiedInstall
shipping-and-launchaddyosmani/agent-skillsPrepares production launches. Use when preparing to deploy to production, or when asking what needs to be in place before shipping. Use when you need a pre-launch checklist, when setting up monitoring, when planning a staged rollout, or when you need a rollback strategy.Stars: 119kUpdated Claude CodeCodexVerifiedInstall
childhoodthedotmack/claude-memBabysit a shipped release after merge, publication, or deployment. Verify published packages, production behavior, installed plugins, and late CI or user reports until the observation window is clean; use babysit for PR readiness before release.Stars: 118kUpdated Claude CodeCodexVerifiedInstall