Sifflet CLI

This package provides a command line interface (CLI) to Sifflet application.

Getting Started

Installation

Sifflet CLI is compatible with Python 3.10 or greater

pip install sifflet

sifflet --version

Configuration

Before using the Sifflet CLI, you need to set your tenant and credentials. You can do it in several ways:

Sifflet command line sifflet configure (which will persists configuration in a file)
Or with environment variables

You will need in both cases the following information:

<access_token>: you can find more information on how to generate it here
For SaaS version: <tenant_name>: Name of your tenant. Sifflet UI URL is https://<tenant_name>.siffletdata.com. Sifflet Backend URL is https://<tenant_name>api.siffletdata.com. For instance, if you access to Sifflet UI with https://mycompany.siffletdata.com, then your tenant would be mycompany.
For self-hosted deployment: <backend_url>: Full URL to the Sifflet backend on your deployment including for instance: https://sifflet-backend.mycompany.com

Sifflet configure

You can input the tenant and credentials directly with the sifflet configure command.

For SaaS version:

> sifflet configure --tenant <tenant_name>
Your API access token [None]: <access_token>

or, for self-hosted deployment:

> sifflet configure --backend-url <backend_url>
Your API access token [None]: <access_token>

The use of sifflet configure will persist the configuration in a file located at ~/.sifflet/config.ini (or in %UserProfile%\.sifflet/config.ini on Windows).

Environment variables

To use environment variables, you can do the following:

For SaaS version:

> export SIFFLET_TENANT=<tenant_name>
> export SIFFLET_TOKEN=<access_token>

or, for self-hosted deployment:

> export SIFFLET_BACKEND_URL=<backend_url>
> export SIFFLET_TOKEN=<access_token>

You can check that setup is done correctly with sifflet status.

> sifflet status

Sifflet version = x.x.x
Tenant = my_tenant
Tenant is up and reachable
Token expiration date = 2024-01-01 00:00:00
Token is valid with scope API
Status = OK

If you encounter any error at this step, please check your tenant and token configurations.

Documentation

The documentation with the available commands can be found here.

Help

The --help option is available for any command, for instance sifflet --help or sifflet rules list --help.

Examples

Trigger a specific rule

First, find your rule id with sifflet rules list. You can filter with --name to narrow your search.

# Display rules
sifflet rules list
sifflet rules list --name <search_criteria>

Then you can trigger one of several rules with sifflet rules run

# Run one or many rules
sifflet rules run --id <rule_id>
sifflet rules run --id <rule_id_1> --id <rule_id_2> --id <rule_id_3>

Finally, retrieve the run status of a rule with sifflet rules run_history

# Display rule runs history for a given rule id
sifflet rules run_history --id <rule_id>

Send dbt artifacts

If you have already added the datasource to Sifflet, you can then send the dbt artifacts for syncing the data.

# send the dbt artifacts
sifflet ingest dbt --project-name <project_name> --target <target> --input-folder <dbt_artifacts_directory>

Contact

For any queries, you can reach us at contact@siffletdata.com

Release files for sifflet 0.6.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sifflet 0.6.1
File	Size	Uploaded
sifflet-0.6.1.tar.gz	11.1 kB	Jul 23, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for sifflet 0.6.1
File	Interpreter	ABI	Platform	Reset
sifflet-0.6.1-py3-none-any.whl 14.4 kB Jul 23, 2026	Python 3	none	any	Details

Total release size: 25.6 kB

Release files / sifflet-0.6.1.tar.gz

Download URL	sifflet-0.6.1.tar.gz
Size	11.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`432c036a6ea8e29322126ac9488a147cb9f6b182a53b1396e8f695a694609bf6`
BLAKE2b-256 checksum How to use checksums	`bc367bc1d7a9f1cf11a9a9a50116c287987059fbce68fc853a5d51745c798c38`
Upload date	Jul 23, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.12.13`

Release files / sifflet-0.6.1-py3-none-any.whl

Download URL	sifflet-0.6.1-py3-none-any.whl
Size	14.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`777031d58372dfc79ad88a067a08b1b7428d27cc5408bdd1d2c4e6dfb6024461`
BLAKE2b-256 checksum How to use checksums	`2d75f1af0839cdabda0e5f0284090f961884ad7f2e32799a4b201025288683bb`
Upload date	Jul 23, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.12.13`