跳到正文
cccskills
免费在 GitHub 公开

estuary-flowctl-setup

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".

中文简介正在准备中。当前显示原文说明。

查看安装方法

包含的文件(1)

  • SKILL.md4.4 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

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

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

Create an Alpaca capture using flowctl to stream stock trade data into Estuary collections. Use when setting up an Alpaca Market Data source for historical and real-time stock trades. Use when user says "capture Alpaca", "stream stock trades", "Alpaca market data", or "connect Alpaca to Estuary".

中文简介正在准备中。当前显示原文说明。

estuary/agent-skills72026年9月25日 更新

Create a capture for ANY Estuary connector using dynamic schema discovery. Use when the user wants to capture from a source that doesn't have a dedicated skill (e.g., Kafka, Salesforce, HubSpot, Stripe, S3, GCS, Kinesis, or any of the 148+ connectors). Use when user says "capture from <source>", "stream from <source>", "connect <source> to Estuary", or "set up <source> capture" and no connector-specific skill exists.

中文简介正在准备中。当前显示原文说明。

estuary/agent-skills72026年9月25日 更新

Create an HTTP Ingest (webhook) capture to receive data via HTTP POST requests. Use when setting up webhooks from GitHub, Shopify, Stripe, or any JSON source. Use when user says "set up webhook capture", "HTTP ingest to Estuary", "receive POST requests to Estuary", or "webhook capture".

中文简介正在准备中。当前显示原文说明。

estuary/agent-skills72026年9月25日 更新

Create a HubSpot Real-Time capture using flowctl to stream CRM data into Estuary collections. Use when setting up a HubSpot source for contacts, companies, deals, tickets, or other HubSpot resources. Use when user says "capture HubSpot", "stream from HubSpot", "HubSpot CDC", or "connect HubSpot to Estuary".

中文简介正在准备中。当前显示原文说明。

estuary/agent-skills72026年9月25日 更新

Create a MongoDB CDC capture using flowctl. Use when setting up real-time streaming from MongoDB Atlas, DocumentDB, or self-hosted MongoDB. Use when user says "capture MongoDB", "stream from Mongo", "MongoDB CDC", or "connect MongoDB to Estuary".

中文简介正在准备中。当前显示原文说明。

estuary/agent-skills72026年9月25日 更新

Create a MySQL CDC capture using flowctl with binlog replication. Use when setting up streaming from MySQL, Amazon RDS MySQL, or Aurora MySQL. Use when user says "capture MySQL", "stream from MySQL", "MySQL CDC", "binlog replication", or "connect MySQL to Estuary".

中文简介正在准备中。当前显示原文说明。

estuary/agent-skills72026年9月25日 更新

查看 estuary 的全部技能

报告此技能的问题