List of Commands
login
login
The login
command lets you add your WorkflowGen credentials to authorize the CLI.
Available since WorkflowGen version 7.0.0.
The WorkflowGen CLI does not support OpenID Connect authentication (Auth0, Okta, Azure AD, AD FS).
Usage
Argument
Options
📌 Example
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
📌 Example
delete-server
delete-server
Deletes the specified server from the configuration.
Usage
Argument
Option
📌 Example
delete-user
delete-user
Deletes the specified user from the configuration.
Usage
Argument
Option
📌 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
📌 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
📌 Example
rename-server
rename-server
Renames a server in the configuration.
Usage
Arguments
📌 Example
rename-user
rename-user
Renames a user in the configuration.
Usage
Arguments
📌 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
Options
📌 Example
set-server
set-server
Sets a server entry in the configuration.
Usage
Argument
Options
📌 Example
set-user
set-user
Sets a user entry in the configuration.
Usage
Argument
Options
📌 Example
use-context
use-context
Sets the current context in the configuration.
Usage
Argument
📌 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
📌 Examples
export
export
Exports a project from your WorkflowGen server to a local repository.
Usage
Option
📌 Example
import
import
Imports a project from a local repository to your WorkflowGen server.
Usage
Options
📌 Example
show
show
Displays the content of a manifest link to a project.
Usage
Option
📌 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
Option
📌 Example
import
import
Imports a specific process from a local repository to your WorkflowGen server.
Usage
Argument
Options
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
📌 Example
update
update
Updates information for a single process.
Usage
Arguments
Options
📌 Example
delete
delete
Deletes a single process by name and version.
Usage
Arguments
📌 Example
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
Option
📌 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
Option
📌 Example
get
get
Displays one or several global lists.
Usage
Argument
📌 Example
delete
delete
Deletes a single global list by name.
Usage
Argument
📌 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
Option
📌 Example
import
import
Imports a specific application from your local repository to your WorkflowGen server.
Usage
Argument
Option
📌 Example
get
get
Displays one or several applications.
Usage
Argument
📌 Example
get-parameters
get-parameters
Displays an application's parameters.
Usage
Argument
📌 Example
delete
delete
Deletes a single application by name.
Usage
Argument
📌 Example
graphql
graphql
The graphql
command lets you run a custom GraphQL query.
Available since WorkflowGen version 7.0.0.
Usage
Arguments
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