List of Commands
login
login
The login
command lets you add your WorkflowGen credentials to authorize the CLI. The CLI supports basic and Open ID Connect authentication.
Basic or Integrated Windows authentication
Basic and Integrated Windows authentication are available since WorkflowGen version 7.0.0.
Auth0 authentication
Auth0 authentication is available since WorkflowGen version 7.11.0.
MSIDV2 (Microsoft Identity Platform v2) authentication
MSIDV2 authentication is available since WorkflowGen version 7.16.0.
For MSIDV2 mode, you must first have registered a new dedicated application (server-side application
) in your Azure Active Directory and on your WorkflowGen server by following the instructions in the Azure AD Configuration for Server-Side Scripts chapter in the WorkflowGen for Azure guide.
All of the operations invoked from the WorkflowGen CLI will therefore use the user account specific in the Impersonate username
field of the Non-interactive client
application associated to the WorkflowGen CLI in WorkflowGen.
Okta authentication
Okta authentication is available since WorkflowGen version 7.13.0.
AD FS authentication
AD FS authentication is available since WorkflowGen 7.11.0.
Argument
Name | Type | Description | Behavior |
| String | WorkflowGen URL | Required |
Options
Alias | Type | Description | Default value | Behavior |
| String | WorkflowGen username | None | Required |
| String | WorkflowGen password | None | Optional |
| String | Webforms path |
| Optional |
| String | Context name |
| Optional |
| String | Authentication mode ( |
| Facultatif |
| String | Client's public identifier | None | Facultatif |
| String |
| Aucune | Facultatif |
| String |
| None | Facultatif |
| String |
| Aucune | Facultatif |
| String | Data known only to the application and the authorization server | Aucune | Facultatif |
| String | File containing the client secret known only to the application and the authorization server | None | Facultatif |
| String | WorkflowGen port | None |
📌 Basic authentication login examples
📌 Auth0 login examples
📌 MSIDV2 login examples
📌 Okta login examples
📌 AD FS login examples
config
config
The config
command lets you configure the CLI.
Available since WorkflowGen version 7.0.0.
current-context
current-context
Displays the current context.
Usage
delete-context
delete-context
Deletes the specified context from the configuration.
Usage
[CONTEXT_NAME]
represents the name given to the CLI context that contains your server and user information.
Argument
Name | Type | Description | Behavior |
| String | Name of the context to delete | Required |
📌 Example
delete-server
delete-server
Deletes the specified server from the configuration.
Usage
Argument
Name | Type | Description | Behavior |
| String | Name of the server to delete | Required |
Option
Alias | Type | Description | Default value | Behavior |
| Boolean | Force the server deletion and delete associated contexts |
| Optional |
📌 Example
delete-user
delete-user
Deletes the specified user from the configuration.
Usage
Argument
Name | Type | Description | Behavior |
| String | Name of the user to delete | Required |
Option
Alias | Type | Description | Default value | Behavior |
| Boolean | Forces the user deletion and deletes associated contexts |
| Optional |
📌 Example
get-contexts
get-contexts
Describes one or several contexts.
Usage
[CONTEXT_NAME]
represents the name given to the CLI context that contains your server and user information.
Argument
Name | Type | Description | Behavior |
| String | Name(s) of context(s) to get | Optional |
📌 Example
get-servers
get-servers
Displays servers defined in the configuration.
Usage
get-users
get-users
Displays users defined in the configuration.
Usage
rename-context
rename-context
Renames a context in the configuration.
Usage
[CONTEXT_NAME]
represents the name given to the CLI context that contains your server and user information.
Arguments
Name | Type | Description | Behavior |
| String | Context name to rename | Required |
| String | New context name | Required |
📌 Example
rename-server
rename-server
Renames a server in the configuration.
Usage
Arguments
Name | Type | Description | Behavior |
| String | Server name to rename | Required |
| String | New server name | Required |
📌 Example
rename-user
rename-user
Renames a user in the configuration.
Usage
Arguments
Name | Type | Description | Behavior |
| String | Username to rename | Required |
| String | New username | Required |
📌 Example
set-context
set-context
Sets a context entry in the configuration.
Usage
[CONTEXT_NAME]
represents the name given to the CLI context that contains your server and user information.
Argument
Name | Type | Description | Behavior |
| String | Context name | Required |
Options
Alias | Type | Description | Default value | Behavior |
| String | Server name | None | Required |
| String | Username | None | Required |
📌 Example
set-server
set-server
Sets a server entry in the configuration.
Usage
Argument
Name | Type | Description | Behavior |
| String | Server name | Required |
Options
Alias | Type | Description | Default value | Behavior |
| String | WorkflowGen URL | None | Optional |
| String | WorkflowGen webforms path | None | Optional |
| String | WorkflowGen version | None | Optional |
📌 Example
set-user
set-user
Sets a user entry in the configuration.
Usage
Argument
Name | Type | Description | Behavior |
| String | Username | Required |
Options
Alias | Type | Description | Default value | Behavior |
| String | WorkflowGen username | None | Required |
| String | WorkflowGen password | None | Required |
📌 Example
use-context
use-context
Sets the current context in the configuration.
Usage
Argument
Name | Type | Description | Behavior |
| String | Context name | Required |
📌 Example
[CONTEXT_NAME]
represent the name given to the CLI context that contains your server and user information.
project
project
The project
command lets you either export or import an entire WorkflowGen project from a manifest.
Available since WorkflowGen version 7.17.0.
init
init
The init
command allow you to generate a manifest.json
file interactively.
Usage
Options
Alias | Type | Description | Default value | Behavior |
| String | Directory path where the project will be initialized | Current directory | Optional |
| Boolean | Generates a |
| Optional |
| Boolean | Forces the |
| Optional |
📌 Examples
export
export
Exports a project from your WorkflowGen server to a local repository.
Usage
Option
Alias | Type | Description | Default value | Behavior |
| String | Path to folder where the project's manifest and files are located. | Current directory | Optional |
📌 Example
import
import
Imports a project from a local repository to your WorkflowGen server.
Usage
Options
Alias | Type | Description | Default value | Behavior |
| String | Project path | Current directory | Optional |
| Boolean | Updates the project's existing global lists and applications |
| Optional |
📌 Example
show
show
Displays the content of a manifest link to a project.
Usage
Option
Alias | Type | Description | Default value | Behavior |
| String | Project path | Current directory | Optional |
📌 Example
process
process
The process
command lets you export
, import
, get
, update
, or delete
a process.
Available since WorkflowGen version 7.17.0.
export
export
Exports a specific process from your WorkflowGen server to a local repository.
Usage
Arguments
Name | Type | Description | Behavior |
| String | Process name | Required |
| Int | Process version | Required |
Option
Alias | Type | Description | Default value | Behavior |
| String | Export path | Current directory | Optional |
📌 Example
import
import
Imports a specific process from a local repository to your WorkflowGen server.
Usage
Argument
Name | Type | Description | Behavior |
| String | Path of the process XML file | Required |
Options
Alias | Type | Description | Default value | Behavior |
| Boolean | Use the process version from the XML file |
| Optional |
| String | Specify with which status the process will be imported |
| Optional |
| String | Destination name of the process folder into which to import the process; the folder should exist |
| Optional |
UseVersionNumber
UseVersionNumber
<use-version-number = true>
will try to add the process with the version number inside the XML file, if it doesn't already exist.<use-version-number = false>
will add the process with the latest version number plus one (e.g. if the latest current version is3
, setting this tofalse
will import the process as version4
).
state
state
The state can be one of the following:
TEST
(default)ACTIVE
DEV
ARCHIVE
📌 Example
get
get
Displays one or several processes.
Usage
Arguments
Name | Type | Description | Behavior |
| String | Process name | Optional |
| Int | Process version | Optional (except if a name is specified) |
📌 Example
update
update
Updates information for a single process.
Usage
Arguments
Name | Type | Description | Behavior |
| String | Process name | Required |
| Int | Process version | Required |
Options
Alias | Type | Description | Default value | Behavior |
| String | Specifies the description with which the process will be updated | None | Optional |
| String | Specify with which status the process will be updated | None | Optional |
📌 Example
delete
delete
Deletes a single process by name and version.
Usage
Arguments
Name | Type | Description | Behavior |
| String | Process name | Required |
| Int | Process version | Required |
📌 Example
test
test
Runs test cases of your processes.
Usage
Arguments
Name | Type | Description | Behavior |
| String | Path(s) to the test file(s) | Required |
Option
Name | Type | Description | Behavior |
| String | Establishes the level of verbosity
Possible values: | Optional |
📌 Example
📌 Example of a test file
global-list
global-list
The global-list
command lets you export
, import
, get
, or delete
a global list.
Available since WorkflowGen version 7.17.0.
export
export
Exports a specific global list from your WorkflowGen server to a local repository.
Usage
Argument
Name | Type | Description | Behavior |
| String | Global list name | Required |
Option
Alias | Type | Description | Default value | Behavior |
| String | Export path | Current directory | Optional |
📌 Example
import
import
Imports a specific global list from your local repository to your WorkflowGen server.
Known issue (#3373): See the WorkflowGen 7.22.2 release notes.
Usage
Argument
Name | Type | Description | Behavior |
| String | The path to the global list's XML file | Required |
Option
Alias | Type | Description | Default value | Behavior |
| Boolean | Updates specified global list |
| Optional |
📌 Example
get
get
Displays one or several global lists.
Usage
Argument
Name | Type | Description | Behavior |
| String | Global list name(s) | Optional |
📌 Example
delete
delete
Deletes a single global list by name.
Usage
Argument
Name | Type | Description | Behavior |
| String | Global list name | Required |
📌 Example
application
application
The application
command lets you export
, import
, get
, get-parameters
, or delete
an application.
Available since WorkflowGen version 7.14.0.
export
export
Exports a specific application from your WorkflowGen server to a local repository.
Usage
Argument
Name | Type | Description | Behavior |
| String | Application name | Required |
Option
Alias | Type | Description | Default value | Behavior |
| String | Export path | Current directory | Optional |
📌 Example
import
import
Imports a specific application from your local repository to your WorkflowGen server.
Usage
Argument
Name | Type | Description | Behavior |
| String | The full path containing the application's JSON file | Required |
Option
Alias | Type | Description | Default value | Behavior |
| Boolean | Updates the specified application |
| Optional |
📌 Example
get
get
Displays one or several applications.
Usage
Argument
Name | Type | Description | Behavior |
| String | Application name(s) | Optional |
📌 Example
get-parameters
get-parameters
Displays an application's parameters.
Usage
Argument
Name | Type | Description | Behavior |
| String | Application name | Required |
📌 Example
delete
delete
Deletes a single application by name.
Usage
Argument
Name | Type | Description | Behavior |
| String | Application name | Required |
📌 Example
graphql
graphql
The graphql
command lets you run a custom GraphQL query.
Available since WorkflowGen version 7.0.0.
Usage
Arguments
Name | Type | Description | Behavior |
| String | Inputs a variable that will be read as a raw string. | See below |
| String | Inputs a variable that the CLI will attempt to cast in a valid JSON type. | See below |
| JSON | Input a JSON object containing the variables' names as keys and variables' values as the values of those keys. 📌 Example: | See below |
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.
📌 Examples
Due to a known PowerShell bug at time of writing (https://github.com/PowerShell/PowerShell/issues/1995), 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 ("""
).
Last updated