Package: bigeye-cli
Bigeye CLIVersion: 0.3.52InstallationSetting up your local/build environmentMac with PyenvInstallbrewInstallpyenvInstall python and define a default global:pyenv install 3.9.13
pyenv global 3.9.13CondaInstallcondaCreate environment with python3.9 or greaterconda create -n bigeye_env python=3.9
conda activate bigeye_envLinuxMost linux distributes include a default python distribution and we recommend using that default.Installing Bigeye-CLIYou can install the Bigeye-CLI from your command line with the following command:pip3 install bigeye-cliConfigurationBefore using the Bigeye CLI, you will need to configure your Bigeye credentials and workspaces. You can do this in the following ways:Configuration CommandEnvironment VariablesCredentials and Configuration FilesConfiguration CommandThe quickest way to get started using the Bigeye CLI is to run thebigeye configurecommand. This command will walk you through the options to establish default credentials and configurations for the Bigeye CLI.$bigeyeconfigureUsing the bigeye configure command, there are two ways to authenticate: basic authentication and browser authentication.Basic AuthenticationIf you select basic authentication, the CLI will prompt you to enter your Bigeye username and password. This will create a default credential file at ~/.bigeye/credentials. This credential will be used for all CLI commandsunless an environment variable is explicitly provided.Browser AuthenticationAlternatively, you can use browser authentication (Linux/Mac OS only). Login to your bigeye workspace on a Chrome, Chromium orFirefox browser. Runbigeye configureand select browser_auth when prompted in the CLI and follow theinstructions. If you use Chrome profiles, make sure to specify the profile email address you are logged into.Note: Your authentication will only be valid so long as your browser session is active. Not supported with SSO enabled.Environment VariablesYou can create an environment variable for your workspace credential and configuration files, this is helpful if you would like to store your credential and configuration files some place other than their default locations (~/.bigeye). You can do this by adding the following to your ~/.bashrc or ~/.zshrc file. Please review the format of these files in the below sections.exportBIGEYE_API_CRED_FILE=/some/path/to/credentials.iniexportBIGEYE_API_CONFIG_FILE=/some/path/to/config.iniCredentials and Configuration FilesLastly, if you want to specify the credential per command, you can always pass a -b parameter with the file path for the desired credential. You can pass a -c parameter with the file path for the desired configuration.Sample credentials file:[DEFAULT]base_url=https://app.bigeye.comuser=some_user@bigeye.compassword=fakepassword1234Sample configuration file:[DEFAULT]workspace_id=123Configuration OptionsThe configuration files can help to simplify other CLI commands by defining common options in one file. Seethe table below for the complete list of configuration options.KeyDescriptionTypeExampleworkspace_idThe id for the workspace [Required]Int123use_default_credentialWhether or not a unique credential is required for this workspace. Default: TrueBoolTruebigconfig_input_pathThe path(s) to bigconfig files that are used for the given workspace.List[strings]path/bigconfig.yml,path2/bigconfig.ymlbigconfig_output_pathThe path used to output bigconfig PLAN reports and FIXME files.Stringoutput/bigconfig_reports/bigconfig_strict_modeAPI errors cause an exception if True. (Validation errors still cause an exception). Default: FalseBoolFalsebigconfig_auto_approveBigconfig applies should be allowed to run without excplit plan approvals. Default: FalseBoolFalseThe configuration options above can be manually set directly in your config.ini files or you can utilize the below command to set the config values.$bigeyeconfigureset<setting_key><value>[OPTIONALWORKSPACE]$bigeyeconfiguresetbigconfig_input_pathpath/bigconfig.yml,path2/bigconfig-wdata-scienceTo view the current value of any specific configuration you can either open the config.ini file or utilize the below command.$bigeyeconfigureget<setting_key>[OPTIONALWORKSPACE]$bigeyeconfiguregetbigconfig_input_path-wdata-scienceMulti-Workspace SupportThe credential and configuration files are designed to allow Bigeye CLI users to easily switch between their Bigeye workspaces. Each file enforces the idea of aDEFAULTsection. All subsequent CLI commands will inherit the properties defined in theDEFAULTsection unless they are directed otherwise. Every command in the Bigeye CLI has the ability to provide a--workspace(-w) option to override the use of the default workspace.To setup a non-default workspace, run the following command:$bigeyeconfigure-wdata-scienceOr, open up the files and manually edit them based on your setup. Here are some samples.Sample configuration file with multiple workspaces:[DEFAULT]workspace_id=123bigconfig_input_path=absolute_path/bigconfig.yml,absolute_path2/bigconfig.ymlbigconfig_output_path=absolute_path/output/[workspace data-science]workspace_id=234use_default_credential=Truebigconfig_input_path=absolute_path/ds/bigconfig.yml,absolute_path2/ds/bigconfig.yml[workspace dev]workspace_id=100use_default_credential=Falsebigconfig_auto_approve=Truebigconfig_input_path=absolute_path/bigconfig.yml,absolute_path2/bigconfig.ymlSample credentials file with multiple workspaces:[DEFAULT]base_url=https://app.bigeye.comuser=some_user@bigeye.compassword=fakepassword1234[dev]base_url=https://app.bigeye.comuser=some_user@bigeye.compassword=fakepassword1234Note:Most use cases will only require you to have a singleDEFAULTcredential that all workspaces can utilize. Running thebigeye configure -w <workspace-name>command for a non-default workspace will prompt you to inherit the credentials from default or create a new set of credentials. A workspace credential is only required if theuse_default_credentialsetting is set to False in the configuration of the corresponding workspace.CLI Documentation