Agent CLI

The Bigeye Agent CLI is a command-line tool for installing, configuring, and managing Bigeye agents in your infrastructure. It provides an interactive setup experience that validates your configuration at each step and manages the lifecycle of all Bigeye agent types.

Supported Agents

Agent	Description
Data Source	Connects to your data warehouses and collects metadata for monitoring in Bigeye. Runs as a long-lived Docker service.
Lineage Plus	Collects lineage metadata from databases, BI tools, and ETL platforms. Runs on-demand or on a schedule.
DataHealth	Monitors data quality through external integrations. Runs on-demand or as a scheduled job.
SDS (Sensitive Data Scanning)	Scans data sources for sensitive data like PII. Runs as a dual-container service (Java + Python).
Cross-Source	Compares data across multiple sources for consistency validation. Runs as a long-lived Docker service.
External Monitors	Integrates with external monitoring tools (e.g., dbt tests). Runs on-demand.

Getting Started

Download and install the CLI
Run ./bigeye-agent install to set up your first agent
Add connectors for your data sources
Start collecting data with agent-specific commands

How It Works

The Agent CLI manages a unified configuration file (bigeye_agent.yml) that stores all agent and connector settings. When you run commands, the CLI reads this configuration, generates the necessary files for each agent, and manages Docker containers or Kubernetes deployments.

bigeye_agent.yml          # Unified configuration (credentials, agents, connectors)
    ├── agent_config/     # Generated Data Source agent config
    ├── lineage_config/   # Generated Lineage Plus config files
    └── ...               # Other agent-specific config directories