# List of Commands ## `login` The `login` command lets you add your WorkflowGen credentials to authorize the CLI. {% hint style="info" %} Available since WorkflowGen version 7.0.0. {% endhint %} {% hint style="warning" %} The WorkflowGen CLI does not support OpenID Connect authentication (Auth0, Okta, Azure AD, AD FS). {% endhint %} #### Usage ``` wfg login [WORKFLOWGEN_URL] -u [WORKFLOWGEN_USERNAME] -p [WORKFLOWGEN_PASSWORD] -c [CONTEXT_NAME] ``` #### Argument | Name | Type | Description | Behavior | | ----- | ------ | --------------- | -------- | | `url` | String | WorkflowGen URL | Required | #### Options | Alias | Type | Description | Default value | Behavior | | -------------------- | ------ | -------------------- | ------------------------------------------ | -------- | | `--username` or `-u` | String | WorkflowGen username | None | Required | | `--password` or `-p` | String | WorkflowGen password | None | Optional | | `--webforms` or `-w` | String | Webforms path | `C:\inetpub\wwwroot\wfgen\wfapps\webforms` | Optional | | `--context` or `-c` | String | Context name | `DEFAULT` | Optional | #### 📌 **Example** ``` wfg login http://localhost:8080/wfgen/ -u wfgen_admin -p YourPassword ``` ## `config` The `config` command lets you configure the CLI. {% hint style="info" %} Available since WorkflowGen version 7.0.0. {% endhint %} ### `current-context` Displays the current context. #### **Usage** ``` wfg config current-context ``` ### `delete-context` Deletes the specified context from the configuration. #### **Usage** ``` wfg config delete-context [CONTEXT_NAME] ``` {% hint style="info" %} `[CONTEXT_NAME]` represents the name given to the CLI context that contains your server and user information. {% endhint %} #### **Argument** | Name | Type | Description | Behavior | | ------ | ------ | ----------------------------- | -------- | | `name` | String | Name of the context to delete | Required | #### 📌 Example ``` wfg config delete-context WFGEN_PROD ``` ### `delete-server` Deletes the specified server from the configuration. #### **Usage** ``` wfg config delete-server [SERVER_NAME] --force ``` #### **Argument** | Name | Type | Description | Behavior | | ------ | ------ | ---------------------------- | -------- | | `name` | String | Name of the server to delete | Required | #### **Option** | Alias | Type | Description | Default value | Behavior | | ----------------- | ------- | -------------------------------------------------------- | ------------- | -------- | | `--force` or `-f` | Boolean | Force the server deletion and delete associated contexts | `false` | Optional | #### 📌 Example ``` wfg config delete-server WFGEN_PROD_SERVER --force ``` ### `delete-user` Deletes the specified user from the configuration. #### **Usage** ``` wfg config delete-user [USER_NAME] --force ``` #### **Argument** | Name | Type | Description | Behavior | | ------ | ------ | -------------------------- | -------- | | `name` | String | Name of the user to delete | Required | #### **Option** | Alias | Type | Description | Default value | Behavior | | ----------------- | ------- | -------------------------------------------------------- | ------------- | -------- | | `--force` or `-f` | Boolean | Forces the user deletion and deletes associated contexts | `false` | Optional | #### 📌 Example ``` wfg config delete-user ADMIN_PROD_ACCOUNT --force ``` ### `get-contexts` Describes one or several contexts. #### **Usage** ``` wfg config get-contexts [CONTEXT_NAME1] [CONTEXT_NAME2] [CONTEXT_NAME3] ``` {% hint style="info" %} `[CONTEXT_NAME]` represents the name given to the CLI context that contains your server and user information. {% endhint %} #### **Argument** | Name | Type | Description | Behavior | | ------- | ------ | ---------------------------- | -------- | | `names` | String | Name(s) of context(s) to get | Optional | #### 📌 Example ``` wfg config get-contexts WFGEN_PROD ``` ### `get-servers` Displays servers defined in the configuration. #### **Usage** ``` wfg config get-servers ``` ### `get-users` Displays users defined in the configuration. #### **Usage** ``` wfg config get-users ``` ### `rename-context` Renames a context in the configuration. #### **Usage** ``` wfg config rename-context [CONTEXT_OLD_NAME] [CONTEXT_NEW_NAME] ``` {% hint style="info" %} `[CONTEXT_NAME]` represents the name given to the CLI context that contains your server and user information. {% endhint %} #### **Arguments** | Name | Type | Description | Behavior | | ---------- | ------ | ---------------------- | -------- | | `old-name` | String | Context name to rename | Required | | `new-name` | String | New context name | Required | #### 📌 Example ``` wfg config rename-context WFGEN_PROD WFGEN_DEV ``` ### `rename-server` Renames a server in the configuration. #### **Usage** ``` wfg config rename-server [SERVER_OLD_NAME] [SERVER_NEW_NAME] ``` #### **Arguments** | Name | Type | Description | Behavior | | ---------- | ------ | --------------------- | -------- | | `old-name` | String | Server name to rename | Required | | `new-name` | String | New server name | Required | #### 📌 Example ``` wfg config rename-server WFGEN_PROD_SERVER WFGEN_DEV_SERVER ``` ### `rename-user` Renames a user in the configuration. #### **Usage** ``` wfg config rename-user [USER_OLD_NAME] [USER_NEW_NAME] ``` #### **Arguments** | Name | Type | Description | Behavior | | --------------- | ------ | ------------------ | -------- | | `USER_OLD_NAME` | String | Username to rename | Required | | `USER_NEW_NAME` | String | New username | Required | #### 📌 Example ``` wfg config rename-user ADMIN_PROD_ACCOUNT ADMIN_DEV_ACCOUNT ``` ### `set-context` Sets a context entry in the configuration. #### **Usage** ``` wfg config set-context [CONTEXT_NAME] --server [SERVER_NAME] --user [USER_NAME] ``` {% hint style="info" %} `[CONTEXT_NAME]` represents the name given to the CLI context that contains your server and user information. {% endhint %} #### **Argument** | Name | Type | Description | Behavior | | ------ | ------ | ------------ | -------- | | `name` | String | Context name | Required | #### **Options** | Alias | Type | Description | Default value | Behavior | | ------------------ | ------ | ----------- | ------------- | -------- | | `--server` or `-s` | String | Server name | None | Required | | `--user` or `-u` | String | Username | None | Required | #### 📌 Example ``` wfg config set-context WFGEN_PROD --server WFGEN_PROD_SERVER --user ADMIN_PROD_ACCOUNT ``` ### `set-server` Sets a server entry in the configuration. #### **Usage** ``` wfg config set-server [SERVER_NAME] --url [URL] --version [SERVER_VERSION] ``` #### **Argument** | Name | Type | Description | Behavior | | ------ | ------ | ----------- | -------- | | `name` | String | Server name | Required | #### **Options** | Alias | Type | Description | Default value | Behavior | | -------------------- | ------ | ------------------------- | ------------- | -------- | | `--url` or `-u` | String | WorkflowGen URL | None | Optional | | `--webforms` or `-w` | String | WorkflowGen webforms path | None | Optional | | `--version` or `-v` | String | WorkflowGen version | None | Optional | #### 📌 Example ``` wfg config set-server WFGEN_PROD_SERVER --url http://localhost:8080/wfgen/admin/ --version 7.22.0 ``` ### `set-user` Sets a user entry in the configuration. #### Usage ``` wfg config set-user [USER_NAME] --username [USER_USERNAME] --password [USER_PASSWORD] ``` #### **Argument** | Name | Type | Description | Behavior | | ------ | ------ | ----------- | -------- | | `name` | String | Username | Required | #### **Options** | Alias | Type | Description | Default value | Behavior | | -------------------- | ------ | -------------------- | ------------- | -------- | | `--username` or `-u` | String | WorkflowGen username | None | Required | | `--password` or `-w` | String | WorkflowGen password | None | Required | #### 📌 Example ``` wfg config set-user ADMIN_PROD_ACCOUNT --username wfgen_admin --password QWRtaW4xMjMh ``` ### `use-context` Sets the current context in the configuration. #### Usage ``` wfg config use-context [CONTEXT_NAME] ``` #### **Argument** | Name | Type | Description | Behavior | | ------ | ------ | ------------ | -------- | | `name` | String | Context name | Required | #### 📌 Example ``` wfg config use-context WFGEN_PROD ``` {% hint style="info" %} `[CONTEXT_NAME]` represent the name given to the CLI context that contains your server and user information. {% endhint %} ## `project` The `project` command lets you either export or import an entire WorkflowGen project from a manifest. {% hint style="info" %} Available since WorkflowGen version 7.17.0. {% endhint %} ### `init` The `init` command allow you to generate a `manifest.json` file interactively. **Usage** ``` wfg project init --path ProjectPath ``` **Options** | Alias | Type | Description | Default value | Behavior | | ----------------- | ------- | -------------------------------------------------------------- | ----------------- | -------- | | `--path` or `-p` | String | Directory path where the project will be initialized | Current directory | Optional | | `--bare` | Boolean | Generates a `manifest.json` file with the bare minimum content | `false` | Optional | | `--force` or `-f` | Boolean | Forces the `manifest.json` generation | `false` | Optional | #### 📌 Examples ``` wfg project init --path ./MyProject ``` ``` wfg project init --path ./MyProject --bare --force ``` ### `export` Exports a project from your WorkflowGen server to a local repository. #### **Usage** ``` wfg project export --path [PROJECT_PATH] ``` #### **Option** | Alias | Type | Description | Default value | Behavior | | ---------------- | ------ | ------------------------------------------------------------------ | ----------------- | -------- | | `--path` or `-p` | String | Path to folder where the project's manifest and files are located. | Current directory | Optional | #### 📌 Example ``` wfg project export --path ./MyProject ``` ### `import` Imports a project from a local repository to your WorkflowGen server. #### **Usage** ``` wfg project import --source [PATH] --force ``` #### **Options** | Alias | Type | Description | Default value | Behavior | | ------------------ | ------- | ------------------------------------------------------------ | ----------------- | -------- | | `--source` or `-s` | String | Project path | Current directory | Optional | | `--force` or `-f` | Boolean | Updates the project's existing global lists and applications | `false` | Optional | #### 📌 Example ``` wfg project import --source C:\repository ``` ### `show` Displays the content of a manifest link to a project. **Usage** ``` wfg project show --path [PROJECT_PATH] ``` #### **Option** | Alias | Type | Description | Default value | Behavior | | ---------------- | ------ | ------------ | ----------------- | -------- | | `--path` or `-p` | String | Project path | Current directory | Optional | #### 📌 Example ``` wfg project show --path C:\repository ``` ## `process` The `process` command lets you `export`, `import`, `get`, `update`, or `delete` a process. {% hint style="info" %} Available since WorkflowGen version 7.17.0. {% endhint %} ### `export` Exports a specific process from your WorkflowGen server to a local repository. #### **Usage** ``` wfg process export [PROCESS_NAME] [PROCESS_VERSION] --destination [PATH] ``` #### **Arguments** | Name | Type | Description | Behavior | | --------- | ------ | --------------- | -------- | | `name` | String | Process name | Required | | `version` | Int | Process version | Required | #### **Option** | Alias | Type | Description | Default value | Behavior | | ----------------------- | ------ | ----------- | ----------------- | -------- | | `--destination` or `-d` | String | Export path | Current directory | Optional | #### 📌 Example ``` wfg process export SIMPLE_APPROVAL 1 ``` ### `import` Imports a specific process from a local repository to your WorkflowGen server. #### **Usage** ``` wfg process import [PROCESS_PATH] --useVersionNumber --state [STATE] --folder [PROCESS_FOLDER] ``` #### **Argument** | Name | Type | Description | Behavior | | ----------- | ------ | ---------------------------- | -------- | | `file-path` | String | Path of the process XML file | Required | #### **Options** | Alias | Type | Description | Default value | Behavior | | ---------------------- | ------- | ------------------------------------------------------------------------------------------------ | ------------- | -------- | | `--use-version-number` | Boolean | Use the process version from the XML file | `false` | Optional | | `--state` or `-s` | String | Specify with which status the process will be imported | `TEST` | Optional | | `--folder` | String | Destination name of the process folder into which to import the process; the folder should exist | `DEFAULT` | Optional | {% hint style="info" %} #### **`UseVersionNumber`** * `` will try to add the process with the version number inside the XML file, if it doesn't already exist.
* `` will add the process with the latest version number plus one (e.g. if the latest current version is `3`, setting this to `false` will import the process as version `4`). #### **`state`** The state can be one of the following: * `TEST` (default) * `ACTIVE` * `DEV` * `ARCHIVE` {% endhint %} #### 📌 Example ``` wfg process import C:\repository\SIMPLE_APPROVALv1.xml ``` ### `get` Displays one or several processes. #### **Usage** ``` wfg process get [PROCESS_NAME] [PROCESS_VERSION] ``` #### **Arguments** | Name | Type | Description | Behavior | | --------- | ------ | --------------- | ---------------------------------------- | | `name` | String | Process name | Optional | | `version` | Int | Process version | Optional (except if a name is specified) | #### 📌 Example ``` wfg process get SIMPLE_APPROVAL 1 ``` ### `update` Updates information for a single process. #### **Usage** ``` wfg process update [PROCESS_NAME] [PROCESS_VERSION] -d [DESCRIPTION] -s [STATE] ``` #### **Arguments** | Name | Type | Description | Behavior | | --------- | ------ | --------------- | -------- | | `name` | String | Process name | Required | | `version` | Int | Process version | Required | #### Options | Alias | Type | Description | Default value | Behavior | | ----------------------- | ------ | ---------------------------------------------------------------- | ------------- | -------- | | `--description` or `-d` | String | Specifies the description with which the process will be updated | None | Optional | | `--state` or `-s` | String | Specify with which status the process will be updated | None | Optional | {% hint style="info" %} #### **`state`** The state can be one of the following: * `TEST` * `ACTIVE` * `DEV` * `ARCHIVE` {% endhint %} #### 📌 Example ``` wfg process update SIMPLE_APPROVAL 1 -s DEV ``` ### `delete` Deletes a single process by name and version. #### **Usage** ``` wfg process delete [PROCESS_NAME] [PROCESS_VERSION] ``` #### Arguments | Name | Type | Description | Behavior | | --------- | ------ | --------------- | -------- | | `name` | String | Process name | Required | | `version` | Int | Process version | Required | #### 📌 Example ``` wfg process delete SIMPLE_APPROVAL 1 ``` ## `global-list` The `global-list` command lets you `export`, `import`, `get`, or `delete` a global list. {% hint style="info" %} Available since WorkflowGen version 7.17.0. {% endhint %} ### `export` Exports a specific global list from your WorkflowGen server to a local repository. #### **Usage** ``` wfg global-list export [GLOBAL_LIST_NAME] --destination [PATH] ``` #### **Argument** | Name | Type | Description | Behavior | | ------ | ------ | ---------------- | -------- | | `name` | String | Global list name | Required | #### **Option** | Alias | Type | Description | Default value | Behavior | | ----------------------- | ------ | ----------- | ----------------- | -------- | | `--destination` or `-d` | String | Export path | Current directory | Optional | #### 📌 Example ``` wfg global-list export Country ``` ### `import` Imports a specific global list from your local repository to your WorkflowGen server. {% hint style="warning" %} **Known issue (#3373):** See the [WorkflowGen 7.22.2 release notes](https://discuss.workflowgen.com/t/workflowgen-7-22-2). {% endhint %} #### **Usage** ``` wfg global-list import [GLOBAL_LIST_PATH] --force ``` #### **Argument** | Name | Type | Description | Behavior | | ----------- | ------ | -------------------------------------- | -------- | | `file-path` | String | The path to the global list's XML file | Required | #### **Option** | Alias | Type | Description | Default value | Behavior | | ----------------- | ------- | ----------------------------- | ------------- | -------- | | `--force` or `-f` | Boolean | Updates specified global list | `false` | Optional | #### 📌 Example ``` wfg global-list import C:\repository\Country ``` ### `get` Displays one or several global lists. #### **Usage** ``` wfg global-list get [GLOBAL_LIST_NAME] ``` #### **Argument** | Name | Type | Description | Behavior | | ------- | ------ | ------------------- | -------- | | `names` | String | Global list name(s) | Optional | #### 📌 Example ``` wfg global-list get Country Clients ``` ### `delete` Deletes a single global list by name. #### **Usage** ``` wfg global-list delete [GLOBAL_LIST_NAME] ``` #### **Argument** | Name | Type | Description | Behavior | | ------ | ------ | ---------------- | -------- | | `name` | String | Global list name | Required | #### 📌 Example ``` wfg global-list delete Country ``` ## `application` The `application` command lets you `export`, `import`, `get`, `get-parameters`, or `delete` an application. {% hint style="info" %} Available since WorkflowGen version 7.14.0. {% endhint %} ### `export` Exports a specific application from your WorkflowGen server to a local repository. #### **Usage** ``` wfg application export [APPLICATION_NAME] --destination [PATH] ``` #### **Argument** | Name | Type | Description | Behavior | | ------ | ------ | ---------------- | -------- | | `name` | String | Application name | Required | #### **Option** | Alias | Type | Description | Default value | Behavior | | ----------------------- | ------ | ----------- | ----------------- | -------- | | `--destination` or `-d` | String | Export path | Current directory | Optional | #### 📌 Example ``` wfg application export XMLTODATABASE ``` ### `import` Imports a specific application from your local repository to your WorkflowGen server. #### **Usage** ``` wfg application import [APPLICATION_PATH] --force ``` #### **Argument** | Name | Type | Description | Behavior | | ----------- | ------ | ---------------------------------------------------- | -------- | | `file-path` | String | The full path containing the application's JSON file | Required | #### **Option** | Alias | Type | Description | Default value | Behavior | | ----------------- | ------- | --------------------------------- | ------------- | -------- | | `--force` or `-f` | Boolean | Updates the specified application | `false` | Optional | #### 📌 Example ``` wfg application import C:\repository\XMLTODATABASE.xml ``` ### `get` Displays one or several applications. #### **Usage** ``` wfg application get [APPLICATION_NAME] ``` #### **Argument** | Name | Type | Description | Behavior | | ------- | ------ | ------------------- | -------- | | `names` | String | Application name(s) | Optional | #### 📌 Example ``` wfg application get XMLTODATABASE ``` ### `get-parameters` Displays an application's parameters. #### **Usage** ``` wfg application get-parameters [APPLICATION_NAME] ``` #### **Argument** | Name | Type | Description | Behavior | | ------ | ------ | ---------------- | -------- | | `name` | String | Application name | Required | #### 📌 Example ``` wfg application get-parameters XMLTODATABASE ``` ### `delete` Deletes a single application by name. #### **Usage** ``` wfg application delete [APPLICATION_NAME] ``` #### **Argument** | Name | Type | Description | Behavior | | ------ | ------ | ---------------- | -------- | | `name` | String | Application name | Required | #### 📌 Example ``` wfg application delete XMLTODATABASE ``` ## `graphql` The `graphql` command lets you run a custom GraphQL query. {% hint style="info" %} Available since WorkflowGen version 7.0.0. {% endhint %} #### Usage ``` wfg graphql [GRAPHQL_QUERY] -v [VARIABLE1_STRING] -V [VARIABLE2_INT] -V [VARIABLE3_BOOL] ``` ``` wfg graphql [GRAPHQL_QUERY] --variableJson [VARIABLES_JSON] ``` #### Arguments | Name | Type | Description | Behavior | | ------------------------ | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | | `--variable` or `-v` | String | Inputs a variable that will be read as a raw string. | See below | | `--variableCast` or `-V` | String | Inputs a variable that the CLI will attempt to cast in a valid JSON type. | See below | | `--variableJson` | JSON |

Input a JSON object containing the variables' names as keys and variables' values as the values of those keys.

📌 Example: { "key": "value" }

| See below | {% hint style="warning" %} If the `graphql` query uses variables, you have to specify **either** `--variable` and `--variableCast` **or** `--variableJson`. You can't use `--variableJson` with the other two arguments and vice-versa. {% endhint %} #### 📌 Examples {% tabs %} {% tab title="PowerShell" %} ```bash wfg graphql "query { viewer { userName } }" ``` {% endtab %} {% tab title="Bash" %} ```bash wfg graphql "query { viewer { userName } }" ``` {% endtab %} {% endtabs %} {% tabs %} {% tab title="PowerShell" %} ```bash wfg graphql @' query ($name: String!, $version: Int!) { process(name: $name, version: $version) { description } } '@ -v name=SIMPLE_APPROVAL -V version=1 ``` {% endtab %} {% tab title="Bash" %} ```bash wfg graphql "$(cat <), any double quotes (`"`) will be stripped from the string when sending it to a native executable. The solution is to add a backslash (`\`) before each double quote, or use three double quotes (`"""`). {% endhint %} {% endtab %} {% tab title="Bash" %} ```bash wfg graphql "$(cat <