generated: '2026-08-02'
method: searched
source: https://docs.bigeye.com/docs/cli + https://docs.bigeye.com/docs/agent-cli + https://docs.bigeye.com/docs/command-reference
note: >-
  Bigeye ships two distinct first-party command line tools: the Bigeye-CLI
  (a Python package that drives the workspace over the REST API) and the
  Agent CLI (a downloadable binary that installs and operates the self-hosted
  data source, lineage, sensitivity and cross-source agents).
clis:
- name: Bigeye-CLI
  binary: bigeye
  tagline: Power tools for your command line
  docs: https://docs.bigeye.com/docs/cli
  package: bigeye-cli
  registry: pypi
  version: 0.8.5
  url: https://pypi.org/project/bigeye-cli/
  language: python
  minimum_runtime: Python 3.11
  purpose: >-
    Manage a Bigeye workspace at scale — refresh autometrics, edit and run
    metrics, set up and run deltas, and deploy YAML observability-as-code
    (bigconfig) configuration.
  install:
  - {method: pip, command: pip3 install bigeye-cli}
  - {method: venv + pyenv (macOS), command: 'pyenv install 3.11 && python3 -m venv bigeye_cli
      && source bigeye_cli/bin/activate && python -m pip install bigeye-cli'}
  - {method: conda, command: conda create -n bigeye_cli python=3.11 && conda activate
      bigeye_cli && pip install bigeye-cli}
  - {method: 'windows (chocolatey)', command: 'choco install python --version=3.11
      && python3 -m venv bigeye_cli && bigeye_cli\Scripts\activate && python -m pip
      install bigeye-cli'}
  authentication:
    command: bigeye configure
    modes:
    - {name: basic, description: Prompts for Bigeye username and password; writes ~/.bigeye/credentials.}
    - {name: browser_auth, description: 'Reuses an active Chrome/Chromium/Firefox Bigeye
        session; valid only while the browser session lives.'}
    credential_file: ~/.bigeye/credentials
    config_file: ~/.bigeye/config
    minimum_version_for_configure: 0.3.40
    legacy_command: bigeye credential
  commands:
  - {command: bigeye configure, description: Interactive setup of default credentials
      and configuration.}
  - {command: bigeye configure -w <workspace-name>, description: Configure a named
      workspace (multi-workspace support).}
  - {command: 'bigeye configure set <setting_key> <value> [WORKSPACE]', description: Set
      a configuration value, optionally scoped to a workspace.}
  - {command: 'bigeye configure get <setting_key> [WORKSPACE]', description: Read a
      configuration value.}
  - {command: bigeye --version, description: Print the installed CLI version.}
  - {command: bigeye --help, description: Full command reference (the authoritative
      list is generated by the binary, not published as a docs page).}
  capabilities:
  - refresh autometrics
  - edit and run metrics
  - set up and run deltas
  - deploy bigconfig observability-as-code YAML
  observability_as_code:
    setting: bigconfig_input_path
    example: bigeye configure set bigconfig_input_path path/bigconfig.yml -w data-science
    docs: https://docs.bigeye.com/recipes/pipeline-reliability-as-code
    example_repo: https://github.com/bigeyedata/bigeye-demo-workspace
  surface_note: >-
    Bigeye does not publish a per-command reference page for the Bigeye-CLI; the
    docs point at `bigeye --help` and the PyPI page. Only the commands quoted
    above are recorded — the rest are not guessed.
- name: Agent CLI
  binary: ./bigeye-agent
  docs: https://docs.bigeye.com/docs/agent-cli
  command_reference: https://docs.bigeye.com/docs/command-reference
  install_docs: https://docs.bigeye.com/docs/installation
  purpose: Install, configure and manage self-hosted Bigeye agents.
  deployment_methods: [docker, kubernetes]
  config_file: bigeye_agent.yml
  global_commands:
  - {command: ./bigeye-agent install, description: Interactive wizard to install any
      agent type.}
  - {command: './bigeye-agent configure [component]', description: 'Reconfigure credentials;
      pass secrets_manager to configure only the secrets manager.'}
  - {command: './bigeye-agent sync [--restart] [--refresh-credentials]', description: Sync
      bigeye_agent.yml changes to all agents.}
  - {command: './bigeye-agent add-connector [-c TYPE] [--from-existing PATH] [--skip-validation]',
     description: Add a new data source connector.}
  - {command: './bigeye-agent edit-connector [-c TYPE]', description: Edit an existing
      connector's configuration.}
  - {command: './bigeye-agent delete-connector [-c TYPE] [-cn NAME]', description: Delete
      a connection from the agent configuration.}
  - {command: ./bigeye-agent upsert-integration, description: Update or add a DataHealth
      integration config.}
  agent_command_groups:
  - group: source
    agent: Data Source Agent
    commands: ['source configure [--overwrite]', source upgrade, source start, source
        stop, source logs, 'source share-diagnostics [-m MESSAGE]']
  - group: lineage
    agent: Lineage Plus Agent
    commands: ['lineage configure [--overwrite]', lineage configure notifications,
      lineage configure log-retention, lineage upgrade, 'lineage run [-c TYPE] [-n
        NAME] [--no-sync] [--skip-notifications]', lineage logs -c TYPE, 'lineage share-diagnostics
        [-c TYPE] [-m MESSAGE]', 'lineage update-connections [--apply] [--skip-config-validation]
        [-cn NAME]']
  - group: datahealth
    agent: DataHealth Agent
    commands: ['datahealth run --file-name FILE [--command CMD]', datahealth upgrade,
      datahealth configure-sources, datahealth logs]
  - group: sds
    agent: Sensitive Data Scanning Agent
    commands: ['sds configure [--overwrite]', sds upgrade, sds start, sds stop, 'sds
        logs [-c java|python]', 'sds share-diagnostics [-m MESSAGE]']
  - group: crosssource
    agent: Cross-Source Agent
    commands: ['crosssource configure [--overwrite]', crosssource upgrade, crosssource
        start, crosssource stop, crosssource logs, 'crosssource share-diagnostics [-m
        MESSAGE]']
  - group: external-monitors
    agent: External Monitors Agent
    commands: ['external-monitors configure [--overwrite]']
    note: Group truncated to what the published command reference lists.
orchestration:
- name: Airflow operators
  package: bigeye-airflow
  registry: pypi
  url: https://pypi.org/project/bigeye-airflow/
  docs: https://docs.bigeye.com/recipes/create-run-metrics-via-airflow