--- title: Use the Discovery application (CLI version) description: The biGENIUS Discovery CLI is a command-line interface application for managing discovery configurations. It allows users to create, edit, inspect, and run discovery processes for various data sources like SQL Server, MySQL, and more. --- [Skip to content](https://knowledge.bigenius-x.com/use-the-discovery-application-cli-version#main-content) [Contact us](https://knowledge.bigenius-x.com/kb-tickets/new?hsLang=en) [Go to Customer Portal](https://knowledge.bigenius-x.com/customer-portal?hsLang=en) [![TRI\_Logo\_biGENIUS\_2020\_RGB\_s](https://knowledge.bigenius-x.com/hs-fs/hubfs/Marketing/TRI_Logo_biGENIUS_2020_RGB_s.png?width=150&height=42&name=TRI_Logo_biGENIUS_2020_RGB_s.png)](https://www.bigenius-x.com/) Open main navigation Close main navigation - [Contact us](https://knowledge.bigenius-x.com/kb-tickets/new) - [Go to Customer Portal](https://knowledge.bigenius-x.com/customer-portal) How can we help you? - There are no suggestions because the search field is empty. 1. [biGENIUS-X Knowledge Base](https://knowledge.bigenius-x.com/?hsLang=en) 2. [Discovery application](https://knowledge.bigenius-x.com/discovery-application?hsLang=en) # Use the Discovery application (CLI version)   **No installation is required**: launch the application file, which you can download [**here.**](https://knowledge.bigenius-x.com/download-the-discovery-application?hsLang=en) (Pictured is the Windows CLI) ![](https://knowledge.bigenius-x.com/hs-fs/hubfs/image-png-Jun-23-2025-08-00-52-3729-AM.png?width=441&height=222&name=image-png-Jun-23-2025-08-00-52-3729-AM.png) ### Running Modes The application can be run in two modes: - **Direct Mode**: Execute commands directly from your terminal ``` bigenius-discovery [options] ``` - **Interactive Mode**: Start an interactive shell session ``` bigenius-discovery ``` ### Commands #### discover The `discover` command is used to run discovery processes, including loading source system data and generating discovery files. Both processes are being executed by a single `discover` command. If values for the argument `--api-connection-properties` are provided, the command will upload the discovery file directly to the data marketplace of your organization. If this property is not provided, the command will save the generated discovery file directly to disc on the local machine. **Usage:** `discover [discovery-name] [options]`   **Options:** - ``: Name of the discovery configuration to run - `--output, -o`: Custom output path for the discovery file - `--sensitive-property, -sp`: Sensitive properties (e.g., passwords) in format 'PropertyName=Value' - `--sensitive-properties-file, -spf`: Path to a file containing sensitive properties (supports .csv, .env, .ini, .json, .toml, .xml, .yaml, .yml) - `--api-connection-properties, -api`: API connection properties in format 'PropertyName=Value'. Can be specified multiple times for different properties. Used to configure the API storage adapter. Available properties are: - `ClientId` (string, mandatory) - `ClientSecret` (string, mandatory) - `SourceSystemName` (string, mandatory) - `Version` (string, mandatory) - `Description` (string, optional) - `--api-connection-properties-file, -apif` Path to a file containing API connection properties (supports .csv, .env, .ini, .json, .toml, .xml, .yaml, .yml) - `--list, -l`: List all available discovery configurations - `--list-sensitive, -ls`: List sensitive properties for configurations **Examples:** ` # List all configurations` `discover --list` `# List sensitive properties for all configurations` `discover --list-sensitive` `# List sensitive properties for a specific configuration` `discover MyConfig --list-sensitive` `# Run a discovery with sensitive properties` `discover MyConfig --property Password=mypass ApiKey=mykey` `# Run a discovery with sensitive properties and upload discovery file to biGENIUS-X data marketplace.` `discover MyConfig --property Password=mypass --api-connection-properties ClientId="xyz" ClientSecret="mySecret" SourceSystemName="AdventureWorks" Version="1.0.0" ` `# Run a discovery with custom output path` `discover MyConfig --output "C:\Output\my-discovery.yaml"`     If you have multiple discoveries with the same name, all of them will be retrieved and discovered with the same command. If you want to avoid having multiple discoveries running at the same time, make sure that each discovery configuration has a unique name. #### create The `create` command is used to create new discovery configurations. **Usage:** `create --name [options]` **Options:** - ``: Type of discovery configuration to create - `--name, -n`: Name for the new configuration - `--properties, -p`: Configuration properties in format 'PropertyName=Value' - `--properties-file, -f`: Path to a file containing properties (supports .csv, .env, .ini, .json, .toml, .xml, .yaml, .yml) - `--list, -l`: List all available discovery types **Examples:**  `# List available discovery types create --list # Create a SQL Server configuration with command line properties create "SQL Server" --name "MyDatabase" --properties Server="localhost" Database="mydatabase" AuthenticationType="SQL Server Authentication" User="sa" Schema="dbo" # Create a configuration using a properties file create "SQL Server" --name "MyDatabase" --properties-file "config.json" # Create a configuration using a CSV file create "SQL Server" --name "MyDatabase" --properties-file "config.csv" # Create a configuration using an environment file create "SQL Server" --name "MyDatabase" --properties-file ".env" # Create a configuration using a YAML file create "SQL Server" --name "MyDatabase" --properties-file "config.yaml"`   **Escaping Characters:** If you want to use special characters like " or \\\\ in your command, you need to escape them properly like \\\\" or \\\\\\\\. When using a properties file, the file format is automatically detected from the file extension. Supported formats include: - CSV (.csv) - Environment files (.env) - INI files (.ini) - JSON files (.json) - TOML files (.toml) - XML files (.xml) - YAML files (.yaml, .yml) More information and additional examples for external config files are available [here](https://knowledge.bigenius-x.com/understand-input-configuration-file-examples-for-bigenius-discovery-cli?hsLang=en). #### create-and-discover The create-and-discover command creates a new discovery configuration and immediately runs the discovery process. **Hint:** If values for the argument `--api-connection-properties` are provided, the command will upload the discovery file directly to your organization's data marketplace. If this property is not provided, the command will save the generated discovery file directly to the local machine.   **Usage:** `create-and-discover --name [options]` **Options:** - ``: Type of discovery configuration to create - `--sensitive-properties, -sp`: Configuration properties in format 'PropertyName=Value' - `--sensitive-properties-file, -spf`: Path to a file containing properties (supports .csv, .env, .ini, .json, .toml, .xml, .yaml, .yml) - `--output, -o`: Custom output path for the discovery file - `--property, -sp`: Sensitive properties in format 'PropertyName=Value' - `--api-connection-properties, -api`: API connection properties in format 'PropertyName=Value'. Can be specified multiple times for different properties. Used to configure the API storage adapter. Available properties are: - `ClientId` (string, mandatory) - `ClientSecret` (string, mandatory) - `SourceSystemName` (string, mandatory) - `Version` (string, mandatory) - `Description` (string, optional) - `--api-connection-properties-file, -apif` Path to a file containing API connection properties (supports .csv, .env, .ini, .json, .toml, .xml, .yaml, .yml) - `--list, -l`: List all available discovery types - `--delete-after, -d`: Delete the discovery configuration after running discovery **Examples:** ` # Create and run a discovery with properties` `create-and-discover "SQL Server" --name "MyDatabase" --properties Server="localhost" Database="mydatabase"` `# Create and run a discovery with properties file and sensitive properties` `create-and-discover "SQL Server" --name "MyDatabase" --properties-file "config.json" --property Password="mypass"` `# Create and run a discovery with deletion after completion` `create-and-discover "SQL Server" --name "TempDB" --properties-file "config.json" --property Password="mypass" --delete-after` `# Create and upload a discovery to the biGENIUX-X data marketplace API. ` `create-and-discover "SQL Server" --name "TempDB" --properties-file "config.json" --property Password="mypass" --api-connection-properties ClientId="xyz" ClientSecret="mySecret" SourceSystemName="AdventureWorks" Version="1.0.0"  --delete-after`   **Note:** When using a properties file, the file format is automatically detected from the file extension. Supported formats include: - CSV (.csv) - Environment files (.env) - INI files (.ini) - JSON files (.json) - TOML files (.toml) - XML files (.xml) - YAML files (.yaml, .yml) More information and additional examples for external config files are available [here](https://knowledge.bigenius-x.com/understand-input-configuration-file-examples-for-bigenius-discovery-cli?hsLang=en). #### edit The `edit` command allows modification of existing discovery configurations. **Usage:** `edit --properties ` **Options:** - ``: Name of the configuration to edit - `--properties, -p`: Properties to update in format 'PropertyName=Value' **Examples:** ` # Update server and database properties` `edit MyDatabase --properties Server="newserver" Database="newdb"` `# Update multiple properties` `edit MyConfig --properties User="newuser" Password="newpass" Server="newserver"`   If you have multiple discoveries with the **same name**, all of them will be updated with the same values in one command. If you want to avoid updating multiple discoveries being updated at the same time, make sure that each discovery configuration has a unique name. #### delete The `delete` command removes existing discovery configurations. **Usage:** `delete ` **Examples:** `# Delete a configuration delete MyDatabase` ` ` If you have multiple discoveries with the **same name**, all of them will be updated with the same values in one command. If you want to avoid updating multiple discoveries being updated at the same time, make sure that each discovery configuration has a unique name. #### inspect The `inspect` command provides detailed information about discovery types or configurations. **Usage:** `inspect [options]` **Options:** - `--type, -t`: Inspect the required properties and allowed values for a discovery configuration type - `--name, -n`: Inspect the properties and values of an existing discovery configuration **Examples:** ` # Inspect a discovery type` `inspect --type "SQL Server"` `# Inspect a configuration` `inspect --name MyDatabase` ### Interactive Mode In interactive mode, the CLI provides a shell-like interface with command history and enhanced usability. **Features:** - Command history (accessible with up/down arrow keys) - Built-in help system **Commands in Interactive Mode:** `# Start interactive mode` `bigenius-discovery` `# Get help` `> help` `# Exit interactive mode` `> exit` `# or` `> quit` ### Examples Check out the article [Do a Discovery with the biGENIUS Discovery App CLI (Walkthrough).](https://knowledge.bigenius-x.com/do-a-discovery-with-the-bigenius-discovery-app-cli-walkthrough?hsLang=en) ### Demonstration video   - [Getting started](https://knowledge.bigenius-x.com/getting-started?hsLang=en#main-content) - [Guidelines](https://knowledge.bigenius-x.com/getting-started?hsLang=en#guidelines) - [Start working](https://knowledge.bigenius-x.com/getting-started?hsLang=en#start-working) - [Account](https://knowledge.bigenius-x.com/getting-started?hsLang=en#account) - [General overview](https://knowledge.bigenius-x.com/general-overview?hsLang=en) - [Artificial Intelligence](https://knowledge.bigenius-x.com/artificial-intelligence?hsLang=en) - [Application Modules](https://knowledge.bigenius-x.com/application-modules?hsLang=en#main-content) - [Administration](https://knowledge.bigenius-x.com/application-modules?hsLang=en#administration) - [Solutions](https://knowledge.bigenius-x.com/application-modules?hsLang=en#solutions) - [Global Features](https://knowledge.bigenius-x.com/application-modules?hsLang=en#global-features) - [Projects](https://knowledge.bigenius-x.com/application-modules?hsLang=en#projects) - [Branches](https://knowledge.bigenius-x.com/application-modules?hsLang=en#branches) - [Data Connections](https://knowledge.bigenius-x.com/application-modules?hsLang=en#data-connections) - [Dataflow Modeling - Overview](https://knowledge.bigenius-x.com/application-modules?hsLang=en#dataflow-modeling-overview) - [Dataflow Modeling - Wizard Steps](https://knowledge.bigenius-x.com/application-modules?hsLang=en#dataflow-modeling-wizard-steps) - [Dataflow Modeling - Terms](https://knowledge.bigenius-x.com/application-modules?hsLang=en#dataflow-modeling-terms) - [Dataflow Modeling - Term Mapping](https://knowledge.bigenius-x.com/application-modules?hsLang=en#dataflow-modeling-term-mapping) - [Dataflow Modeling - Relationships](https://knowledge.bigenius-x.com/application-modules?hsLang=en#dataflow-modeling-relationships) - [Dataflow Modeling - Data Quality](https://knowledge.bigenius-x.com/application-modules?hsLang=en#dataflow-modeling-data-quality) - [Dataflow Modeling - Indexes](https://knowledge.bigenius-x.com/application-modules?hsLang=en#dataflow-modeling-indexes) - [Relationship Modeling](https://knowledge.bigenius-x.com/application-modules?hsLang=en#relationship-modeling) - [Generate Artifacts](https://knowledge.bigenius-x.com/application-modules?hsLang=en#generate-artifacts) - [Project Settings](https://knowledge.bigenius-x.com/application-modules?hsLang=en#project-settings) - [Data Marketplace](https://knowledge.bigenius-x.com/application-modules?hsLang=en#data-marketplace) - [Generators](https://knowledge.bigenius-x.com/generators?hsLang=en#main-content) - [Fabric Warehouse](https://knowledge.bigenius-x.com/generators?hsLang=en#fabric-warehouse) - [Fabric Lakehouse](https://knowledge.bigenius-x.com/generators?hsLang=en#fabric-lakehouse) - [Databricks](https://knowledge.bigenius-x.com/generators?hsLang=en#databricks) - [Snowflake](https://knowledge.bigenius-x.com/generators?hsLang=en#snowflake) - [Microsoft SQL Server](https://knowledge.bigenius-x.com/generators?hsLang=en#microsoft-sql-server) - [Artifacts](https://knowledge.bigenius-x.com/generators?hsLang=en#artifacts) - [Replace Placeholders](https://knowledge.bigenius-x.com/generators?hsLang=en#replace-placeholders) - [Target solution environment](https://knowledge.bigenius-x.com/generators?hsLang=en#target-solution-environment) - [Deployment](https://knowledge.bigenius-x.com/generators?hsLang=en#deployment) - [Deployment with an Azuze DevOps pipeline](https://knowledge.bigenius-x.com/generators?hsLang=en#deployment-with-an-azuze-devops-pipeline) - [Delta Deployment](https://knowledge.bigenius-x.com/generators?hsLang=en#delta-deployment) - [Load control environment](https://knowledge.bigenius-x.com/generators?hsLang=en#load-control-environment) - [Load data with a native load control](https://knowledge.bigenius-x.com/generators?hsLang=en#load-data-with-a-native-load-control) - [Load data with Apache Airflow](https://knowledge.bigenius-x.com/generators?hsLang=en#load-data-with-apache-airflow) - [Model Object Type](https://knowledge.bigenius-x.com/generators?hsLang=en#model-object-type) - [Properties](https://knowledge.bigenius-x.com/generators?hsLang=en#properties) - [Default Terms](https://knowledge.bigenius-x.com/generators?hsLang=en#default-terms) - [Discovery application](https://knowledge.bigenius-x.com/discovery-application?hsLang=en#main-content) - [Discovery configurations](https://knowledge.bigenius-x.com/discovery-application?hsLang=en#discovery-configurations) - [Best practices](https://knowledge.bigenius-x.com/best-practices?hsLang=en#main-content) - [Modeling Approaches](https://knowledge.bigenius-x.com/best-practices?hsLang=en#modeling-approaches) - [Use Cases](https://knowledge.bigenius-x.com/best-practices?hsLang=en#use-cases) - [Business Rules](https://knowledge.bigenius-x.com/best-practices?hsLang=en#business-rules) - [Data Quality Rules](https://knowledge.bigenius-x.com/best-practices?hsLang=en#data-quality-rules) - [FAQs](https://knowledge.bigenius-x.com/faqs?hsLang=en) - [Product Release Notes](https://knowledge.bigenius-x.com/product-release-notes?hsLang=en#main-content) - [SaaS Application](https://knowledge.bigenius-x.com/product-release-notes?hsLang=en#saas-application) - [Discovery application](https://knowledge.bigenius-x.com/product-release-notes?hsLang=en#discovery-application) - [Generators](https://knowledge.bigenius-x.com/product-release-notes?hsLang=en#generators) - [Legal Documents](https://knowledge.bigenius-x.com/legal-documents?hsLang=en#main-content) - [Current legal docs](https://knowledge.bigenius-x.com/legal-documents?hsLang=en#current-legal-docs) - [Software Product and Limits](https://knowledge.bigenius-x.com/legal-documents?hsLang=en#software-product-and-limits) - [Contact us](https://knowledge.bigenius-x.com/kb-tickets/new?hsLang=en) - [Customer Portal](https://knowledge.bigenius-x.com/customer-portal) - [Sign in](https://knowledge.bigenius-x.com/_hcms/mem/login) [![biGENIUS logo](https://knowledge.bigenius-x.com/hubfs/TRI_Logo_biGENIUS_2020_RGB-1.svg "biGENIUS logo")](https://www.bigenius-x.com) All rights reserved © 2025, biGENIUS AG