# Hop Conf - The Hop command line configuration tool ## Hop Conf - The Hop command line configuration tool ### Usage Hop Conf is a command line tool to manage environments. The **hop-conf.sh** script can be run with the **-h** flag (`./hop-conf.sh -h`) to display available options. Usage ```highlight Usage:
[-h] [-ec] [-ed] [-el] [-em] [-ey] [-pc] [-pd] [-pl] [-pm] [-pn] [-py] [-aza=] [-azi=] [-azk=] [-cfg=] [-dc=] [-de=] [-dp=] [-dv=] [-e=] [-ep=] [-eu=] [-fj=] [-gck=] [-gdc=] [-gdt=] [-p=] [-pa=] [-pb=] [-pf=] [-ph=] [-pp=] [-pr=] [-ps=] [-pt=] [-pu=] [-px=] [-sj=] [-sp=] [-sv=] [-xm=] [-cfd= [,...]]... [-cfv=[,...]]... [-eg=[, ...]]... [-pv=[, ...]]... -aza, --azure-account= The account to use for the Azure VFS -azi, --azure-block-increment= The block increment size for new files on Azure, multiples of 512 only. -azk, --azure-key= The key to use for the Azure VFS -cfd, --config-file-describe-variables=[, ...] A list of variable=description combinations separated by a comma -cfg, --config-file= Specify the configuration JSON file to manage -cfv, --config-file-set-variables=[, ...] A list of variable=value combinations separated by a comma -dc, --default-projects-folder= The standard project configuration filename proposed when creating projects -de, --default-environment= The name of the default environment to use when none is specified -dp, --default-project= The name of the default project to use when none is specified -dv, --describe-variable= Describe a variable, use format VARIABLE=Description -e, --environment= The name of the lifecycle environment to manage -ec, --environment-create Create a new project lifecycle environment. Also specify its name, purpose, the project name and the configuration files. -ed, --environment-delete Delete a lifecycle environment -eg, --environment-config-files=[, ...] A list of configuration files for this lifecycle environment, comma separated -el, --environments-list List the defined lifecycle environments -em, --environment-modify Modify a lifecycle environment -ep, --environment-project= The project for the environment -eu, --environment-purpose= The purpose of the environment: Development, Testing, Production, CI, ... -ey, --environment-mandatory Make it mandatory to reference an environment -fj, --generate-fat-jar= Specify the filename of the fat jar to generate from your current software installation -gck, --google-cloud-service-account-key-file= Configure the path to a Google Cloud service account JSON key file -gdc, --google-drive-credentials-file= Configure the path to a Google Drive credentials JSON file -gdt, --google-drive-tokens-folder= Configure the path to a Google Drive tokens folder -h, --help Displays this help message and quits. -p, --project= The name of the project to manage -pa, --project-metadata-base= The metadata base folder (relative to home) -pb, --project-datasets-base= The data sets CSV folder (relative to home) -pc, --project-create Create a new project. Also specify the name and its home -pd, --project-delete Delete a project -pf, --project-config-file= The configuration file relative to the home folder. The default value is project-config.json -ph, --project-home= The home directory of the project -pl, --projects-list List the defined projects -pla, --list-action-types-in-project List action types used in this project -plm, --list-metadata-types-in-project List metadata types used in this project -plt, --list-transform-types-in-project List transform types used in this project -pm, --project-modify Modify a project -pn, --projects-enabled Enable or disable the projects plugin -pp, --project-company= The company -pr, --project-parent= The name of the parent project to inherit metadata and variables from -ps, --project-description= The description of the project -pt, --project-department= The department -pu, --project-unit-tests-base= The unit tests base folder (relative to home) -pv, --project-variables=[,...] A list of variable=value combinations separated by a comma -px, --project-enforce-execution= Validate before execution that a workflow or pipeline is located in the project home folder or a sub-folder (true/false). -py, --project-mandatory Make it mandatory to reference a project -sj, --standard-projects-folder= GUI: The standard projects folder proposed when creating projects -sp, --standard-parent-project= The name of the standard project to use as a parent when creating new projects -sv, --set-variable= Set a variable, use format VAR=Value -xm, --export-metadata= Export project metadata to a single JSON file which you can specify with this option. Also specify the -p option. -v, --version Print version information and exit ``` The available options are listed below: | Short Option | Extended Option | Description | | ------------ | ------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | | -h | --help | Displays this help message and quits | | -v | --version | Print version information and exit | | -ec | --environment-create | Create an environment Also specify the name and its home | | -ed | --environment-delete | Delete an environment | | -el | --environment-list | List the defined environments | | -em | --environment-modify | Modify an environment | | -pc | --project-create | Create a new project. Also specify the name and its home | | -pd | --prject-delete | Delete a project | | -pl | --projects-list | List the defined projects | | -pla | --list-action-types-in-project | List action types used in this project | | -plm | --list-metadata-types-in-project | List metadata types used in this project | | -plt | --list-transform-types-in-project | List transform types used in this project | | -pm | --project-modify | Modify a project | | -dv | --describe-variable=\ | Describe a variable | | -e | -environment=\ | The name of the environment to manage | | -ep | --environment-project=\ | The project for the environment | | -eu | --environment-purpose=\ | The purpose of the environment: Development, Testing, Production, CI, …​ | | -fj | --generate-fat-jar=\ | Specify the filename of the fat jar to generate from your current software installation | | -xm | --export-metadata=\ | Export project metadata to a single JSON file which you can specify with this option. Also specify the -p option to know which metadata to export. | | -p | --project=\ | The project name | | -pa | --project-metadata-base=\ | The metadata base folder (relative to home) | | -pb | --project-datasets-base-base=\ | The data sets CSV folder (relative to home) | | -pf | --project-config-file=\ | The configuration file relative to the home folder. The default value is project-config.json | | -ph | --project-home=\ | The home directory of the project | | -pp | --project-company=\ | The company | | -ps | --project-description=\ | The description of the project | | -pt | --project-department=\ | The department | | -pu | --project-unit-tests-base=\ | The unit tests base folder (relative to home) | | -px | --project-enforce-execution=\ | Validate before execution that a workflow or pipeline islocated in the project home folder or a sub-folder (true/false) | | -sv | --set-variable=\ | Set a variable, use format VAR=Value | | Tip | `-sv` can be used to unset a variable by specifying a variable without a value, e.g. `-sv=myvar=` | | | -cfg | --config-file=\ | Specify the configuration JSON file to manage | | -cfd | --config-file-describe-variables=\\[,\…​] | A list of variable=description combinations separated by a comma | | -cfv | --config-file-set-variables=\ ,\…​] | A list of variable=value combinations separated by a comma | | -eg | --environment-config-files=\\[, \…​] | A list of configuration files for this lifecycle environment, comma separated | | -pv | --project-variables=\\[,\…​] | A list of variable=value combinations separated by a comma | | Tip | `-sv` can be used to unset a variable by specifying a variable without a value, e.g. `-sv=myvar=` | | --- | ------------------------------------------------------------------------------------------------- | #### project variables Examples This is a list of examples on how the parameters on this command are parsed **Normal Usage** ``` --project-variables=key1=value1,key2=value2 ``` Result: | Key | value | | ---- | ------ | | key1 | value1 | | key2 | value2 | **Spaces in value Usage** ``` --project-variables=key1="This value contains spaces",key2=value2 ``` Result: | Key | value | | ---- | -------------------------- | | key1 | This value contains spaces | | key2 | value2 | **Commas in value Usage** ``` --project-variables=key1=\"value1,value2\" ``` Result: | Key | value | | ---- | ------------- | | key1 | value1,value2 | **Forcing quotes in value** ``` --project-variables=key1="\"\"String with spaces\"\"" ``` Result: | Key | value | | ---- | -------------------- | | key1 | "String with spaces" | ### Project Usage and Configuration Unresolved directive in tmp.qllkCkANMx - include::hop-conf-projects.adoc\[] ### Running Workflows and Pipelines Unresolved directive in tmp.qllkCkANMx - include::hop-conf-run-hpl-hwf.adoc\[] ### Cloud Storage Configuration Hop Conf can be used to configure your AWS, Azure and Google Cloud (Cloud Storage and Drive) accounts with Hop through [VFS](https://github.com/mbertazz/hop-docs-md/blob/main/modules/ROOT/pages/hop-tools/hop-conf/vfs.MJ9QLOvSUJ) #### Amazon Web Services S3 N/A #### Azure Set the account, block increment size for new files and your Azure key Unresolved directive in tmp.qllkCkANMx - include::hop-conf-cloud-azure-blob-storage.adoc\[] #### Google **Google Cloud Storage** Set the path to your Google Cloud service account JSON key file Unresolved directive in tmp.qllkCkANMx - include::hop-conf-cloud-google-cloud-storage.adoc\[] **Google Drive** Set the path to your Google Drive credentials JSON file or Google Drive tokens folder. Unresolved directive in tmp.qllkCkANMx - include::hop-conf-cloud-google-drive.adoc\[] Last updated 2025-09-04 18:20:56 +0200 --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.primeur.com/data-shaper-1.21/index-1/hop-conf/hop-conf.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.