Flowctl

The command line interface for Estuary Flow

Installing flowctl

Download the binary for your OS

• All Mac systems with MacOS 11 (Big Sur) or later, including both Intel and M1 Macs: Download here
• Linux (x86-64 only), all distributions: Download here

Make the file executable, rename it, and put it somewhere on your PATH, for example:

chmod +x ~/Downloads/flowctl-multiarch-macos
mv ~/Downloads/flowctl-multiarch-macos /usr/local/bin/flowctl

Verify that it's working by running flowctl --version.

Use the flowctl CLI:

Authentication to Estuary Flow

1. Visit (https://dashboard.estuary.dev/admin) and login.
2. Find the "Access Token" at the bottom of the page, and copy it.
3. Run flowctl auth token --token <paste-your-token-here>

You're ready to go!

Authenticate to a local instance of Flow

Authenticate as "bob@example.com" with your local control-plane API:

flowctl auth develop

Or, grab an access token from the Admin page and pass it in:

flowctl auth develop --token your-access-token

Usage

Create a draft and publish specifications

flowctl draft create
flowctl draft author --source ~/estuary/flow/examples/citi-bike/flow.yaml
flowctl draft publish