The Fivetran CLI lets you manage your Fivetran account from the terminal. Supported operations include creating and updating connections, controlling schema settings, managing users and teams, deploying custom connectors, and more.
To learn more, see our Fivetran CLI documentation
Install
pip install fivetran-cli
Verify the installation:
fivetran --version
Requirements
- Python 3.10 or later
- A Fivetran account and API key for commands that communicate with Fivetran
Authentication
Fivetran API commands require a Base64-encoded API key. Set it as an environment variable:
export FIVETRAN_API_KEY="<base64-encoded-api-key>"
You can also pass the key to an individual command with --api-key:
fivetran beta connection list --api-key "<base64-encoded-api-key>"
See the Fivetran REST API getting started guide for instructions on creating and encoding an API key.
REST API commands
REST API operations use the following command structure:
fivetran beta <resource> <operation> [options]
For example:
List up to 10 connections:
fivetran beta connection list --limit 10
Retrieve one connection:
fivetran beta connection get --connection-id <connection-id>
Trigger a connection sync:
fivetran beta connection sync --connection-id <connection-id>
Use --help to discover the available resources, operations, and command-specific options:
fivetran beta --help
fivetran beta connection --help
fivetran beta connection list --help
Request payloads
Commands that accept a request body support inline JSON, a JSON file, or standard input:
fivetran beta connection create --config '{"group_id":"<group-id>","service":"<service>"}'
fivetran beta connection create --config-file connection.json
Refer to the Fivetran REST API reference for the fields required by each operation.
Output options
REST API commands produce readable terminal output by default. The following options control how successful results are displayed:
| Option | Description |
|---|---|
--output text |
Use formatted terminal output. This is the default. |
--output json |
Write the complete response as JSON. |
--fields id,service |
Display only the selected fields or columns. |
--all-columns |
Show all columns instead of the default 8. |
--output-file <path> |
Write successful output to a file instead of stdout. |
Examples:
Return machine-readable output:
fivetran beta connection list --output json
Select columns for a compact table:
fivetran beta connection list --fields id,service,schema
Write the complete response to a file:
fivetran beta connection list --output json --output-file connections.json
Connector SDK commands
Installing fivetran-cli also installs the Fivetran Connector SDK. Its commands remain available through the same fivetran executable:
Run a connector locally:
fivetran debug
Deploy a connector to Fivetran:
fivetran deploy
See the Connector SDK getting started guide and Connector SDK CLI command reference for details.
Help
Run the following command to see all installed commands, including commands provided by Connector SDK plugins:
fivetran --help
Maintenance
This package is actively maintained by Fivetran developers. Contact the Fivetran Support team for assistance.
Release files for fivetran-cli 1.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| fivetran_cli-1.1.0.tar.gz | 55.3 kB | Without provenance | Details for fivetran_cli-1.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| fivetran_cli-1.1.0-py3-none-any.whl 82.7 kB Without provenance | Python 3 | none | any | Details for fivetran_cli-1.1.0-py3-none-any.whl |
Total release size: 138.0 kB
Security for fivetran-cli 1.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.