Command Reference
Quick reference for all Agent CLI commands
Global Commands
| Command | Description |
|---|---|
./bigeye-agent install | Interactive wizard to install any agent type |
./bigeye-agent configure [component] | Reconfigure credentials. Pass secrets_manager to configure only secrets manager. |
./bigeye-agent sync [--restart] [--refresh-credentials] | Sync bigeye_agent.yml changes to all agents |
./bigeye-agent add-connector [-c TYPE] [--from-existing PATH] [--skip-validation] | Add a new data source connector |
./bigeye-agent edit-connector [-c TYPE] | Edit an existing connector's configuration |
./bigeye-agent upsert-integration | Update or add a DataHealth integration config |
Data Source Agent
| Command | Description |
|---|---|
source configure [--overwrite] | Update Data Source agent configuration |
source upgrade | Update to the latest agent image |
source start | Start the agent |
source stop | Stop the agent |
source logs | View agent logs |
source share-diagnostics [-m MESSAGE] | Share diagnostic logs with Bigeye |
Lineage Plus Agent
| Command | Description |
|---|---|
lineage configure [--overwrite] | Update Lineage Plus configuration |
lineage configure notifications | Configure email notification settings |
lineage configure log-retention | Configure log retention per connector type |
lineage upgrade | Update to the latest agent image |
lineage run [-c TYPE] [-n NAME] [--no-sync] [--skip-notifications] | Run lineage collection |
lineage logs -c TYPE | View logs for a connector type |
lineage share-diagnostics [-c TYPE] [-m MESSAGE] | Share diagnostic logs with Bigeye |
lineage update-connections [--apply] [--skip-config-validation] [-cn NAME] | Update connection mappings |
DataHealth Agent
| Command | Description |
|---|---|
datahealth run --file-name FILE [--command CMD] | Run an integration (default command: run-integration) |
datahealth upgrade | Update to the latest agent image |
datahealth configure-sources | Configure sources for Bigeye workspaces |
datahealth logs | View agent logs |
SDS Agent
| Command | Description |
|---|---|
sds configure [--overwrite] | Update SDS agent configuration |
sds upgrade | Update to the latest agent images |
sds start | Start both Java and Python containers |
sds stop | Stop both containers |
sds logs [-c java|python] | View logs (default: java) |
sds share-diagnostics [-m MESSAGE] | Share diagnostic logs with Bigeye |
Cross-Source Agent
| Command | Description |
|---|---|
crosssource configure [--overwrite] | Update Cross-Source agent configuration |
crosssource upgrade | Update to the latest agent image |
crosssource start | Start the agent |
crosssource stop | Stop the agent |
crosssource logs | View agent logs |
crosssource share-diagnostics [-m MESSAGE] | Share diagnostic logs with Bigeye |
External Monitors Agent
| Command | Description |
|---|---|
external-monitors configure [--overwrite] | Update External Monitors configuration |
external-monitors upgrade | Update to the latest agent image |
external-monitors run -c TYPE [-n NAME] [--create-monitors-only] [--submit-results-only] | Run external monitors |
external-monitors sync | Sync configuration from bigeye_agent.yml |
Job Scheduling
| Command | Description |
|---|---|
jobs list | List all scheduled jobs |
jobs upsert [-n NAME] | Create or update a scheduled job |
jobs remove [-n NAME] | Delete a scheduled job |
Updated about 6 hours ago