CLI Reference

Bizon provides a command-line interface for discovering sources, listing streams, and running pipelines.

Installation

The CLI is automatically installed when you install Bizon:

pip install bizon

Verify the installation:

bizon --help

Commands

bizon run

Run a pipeline from a YAML configuration file.

bizon run <config.yml> [OPTIONS]

Arguments:

Argument	Required	Description
config.yml	Yes	Path to your pipeline configuration file

Options:

Option	Type	Default	Description
--custom-source	Path	None	Path to a custom Python file implementing a Bizon source
--runner	Choice	thread	Runner type: thread, process, or stream
--log-level	Choice	INFO	Log level: DEBUG, INFO, WARNING, ERROR

Examples:

# Basic run
bizon run config.yml

# Run with process-based parallelism
bizon run config.yml --runner process

# Run in streaming mode (continuous)
bizon run config.yml --runner stream

# Run with debug logging
bizon run config.yml --log-level DEBUG

# Run with a custom source connector
bizon run config.yml --custom-source ./my_source.py

bizon source list

List all available source connectors.

bizon source list

Output:

Retrieving available sources...
Available sources:
dummy - ['creatures', 'plants']
kafka - ['topic']
hubspot - ['contacts', 'companies', 'deals']
notion - ['users', 'databases', 'pages']
gsheets - ['spreadsheet']

Sources that require additional dependencies will show an installation hint:

periscope - NOT AVAILABLE, run 'pip install bizon[periscope]' to install missing dependencies.

bizon stream list

List available streams for a specific source.

bizon stream list <source_name>

Arguments:

Argument	Required	Description
source_name	Yes	Name of the source connector

Output:

bizon stream list hubspot

Available streams for hubspot:
[Supports incremental] - contacts
[Supports incremental] - companies
[Full refresh only] - owners

The output indicates whether each stream supports incremental sync mode.

Runner Types

The --runner option determines how the pipeline executes:

Runner	Use Case	Description
thread	Default, most workloads	Uses ThreadPoolExecutor for async I/O operations
process	CPU-intensive transforms	Uses ProcessPoolExecutor for true parallelism
stream	Real-time streaming	Single-threaded synchronous mode for low-latency streaming

Exit Codes

Code	Meaning
0	Pipeline completed successfully
1	Pipeline failed with an error

Environment Variables

You can reference environment variables in your YAML configuration. Bizon will automatically substitute values prefixed with BIZON_ENV_:

authentication:
  type: api_key
  params:
    token: BIZON_ENV_MY_API_TOKEN

Set the environment variable before running:

export BIZON_ENV_MY_API_TOKEN="your-secret-token"
bizon run config.yml

Next Steps

• Configuration Reference - Complete YAML configuration options
• Sync Modes - Understand full refresh, incremental, and stream modes
• Custom Sources - Build your own source connector