flowable-cli
v3.0.1
Published
Flowable CLI
Downloads
138
Readme
flowable-cli
Flowable CLI
Usage
$ npm install -g flowable-cli
$ flowable COMMAND
running command...
$ flowable (--version)
flowable-cli/3.0.1 darwin-arm64 node-v22.21.1
$ flowable --help [COMMAND]
USAGE
$ flowable COMMAND
...Commands
flowable components buildflowable components createflowable components doctorflowable components initflowable components typesflowable components uploadflowable components watchflowable deployflowable environment addflowable environment deleteflowable environment getflowable environment listflowable exportflowable importflowable loginflowable pingflowable publish
flowable components build
Build custom components
USAGE
$ flowable components build [--config <value>] [--env <value>] [-v] [--beautify]
FLAGS
-v, --verbose Verbose mode
--beautify Beautify the output (Not minifying it)
COMMON FLAGS
--config=<value> [default: ~/.flowable/cli-config.yml] Path to the config file
--env=<value> Environment name, if not provided, the selected environment will be used
DESCRIPTION
Build custom componentsflowable components create
Create a new custom component
USAGE
$ flowable components create [--config <value>] [--env <value>]
COMMON FLAGS
--config=<value> [default: ~/.flowable/cli-config.yml] Path to the config file
--env=<value> Environment name, if not provided, the selected environment will be used
DESCRIPTION
Create a new custom componentflowable components doctor
Check the custom components project
USAGE
$ flowable components doctor [--config <value>] [--env <value>]
COMMON FLAGS
--config=<value> [default: ~/.flowable/cli-config.yml] Path to the config file
--env=<value> Environment name, if not provided, the selected environment will be used
DESCRIPTION
Check the custom components projectflowable components init
Initialize a repository for custom components
USAGE
$ flowable components init [--config <value>] [--env <value>] [-b] [-n <value>]
FLAGS
-b, --onlyBoilerplate
-n, --name=<value>
COMMON FLAGS
--config=<value> [default: ~/.flowable/cli-config.yml] Path to the config file
--env=<value> Environment name, if not provided, the selected environment will be used
DESCRIPTION
Initialize a repository for custom componentsflowable components types
Generate typescript types for a custom component properties
USAGE
$ flowable components types [--config <value>] [--env <value>]
COMMON FLAGS
--config=<value> [default: ~/.flowable/cli-config.yml] Path to the config file
--env=<value> Environment name, if not provided, the selected environment will be used
DESCRIPTION
Generate typescript types for a custom component propertiesflowable components upload
Upload the custom components
USAGE
$ flowable components upload [--config <value>] [--env <value>] [--build-dir <value>] [--draft | --minor | --major |
--patch | --version <value>]
FLAGS
--build-dir=<value> Path to the build directory
--draft Upload the components to draft, you can install it later. This prevents non developers from
seeing the new version at Design
--major Increment major version
--minor Increment minor version
--patch Increment patch version
--version=<value> Version to upload (e.g. 1.0.0)
COMMON FLAGS
--config=<value> [default: ~/.flowable/cli-config.yml] Path to the config file
--env=<value> Environment name, if not provided, the selected environment will be used
DESCRIPTION
Upload the custom componentsflowable components watch
Start a developing server
USAGE
$ flowable components watch [--config <value>] [--env <value>] [--ignore-config] [-v]
FLAGS
-v, --verbose Verbose mode
--ignore-config Ignore project configuration
COMMON FLAGS
--config=<value> [default: ~/.flowable/cli-config.yml] Path to the config file
--env=<value> Environment name, if not provided, the selected environment will be used
DESCRIPTION
Start a developing serverflowable deploy
You can deploy an app zip file or a build output from a custom components library
USAGE
$ flowable deploy -i <value> [--config <value>] [--env <value>]
FLAGS
-i, --input=<value> (required) [default: ./dist] Input app zip file path or a build directory path
COMMON FLAGS
--config=<value> [default: ~/.flowable/cli-config.yml] Path to the config file
--env=<value> Environment name, if not provided, the selected environment will be used
DESCRIPTION
You can deploy an app zip file or a build output from a custom components library
Deploy an app to Workflowable environment add
Add or update an environment configuration
USAGE
$ flowable environment add -n <value> -t design|work -b <value> -p <value> [--config <value>] [--env <value>]
FLAGS
-b, --baseUrl=<value> (required) Base URL for the environment
-n, --name=<value> (required) Unique name for the environment
-p, --token=<value> (required) Access token for the environment
-t, --type=<option> (required) Type of the environment
<options: design|work>
COMMON FLAGS
--config=<value> [default: ~/.flowable/cli-config.yml] Path to the config file
--env=<value> Environment name, if not provided, the selected environment will be used
DESCRIPTION
Add or update an environment configurationflowable environment delete
Delete an environment configuration
USAGE
$ flowable environment delete [--config <value>] [--env <value>] [-n <value>] [-a]
FLAGS
-a, --all Delete all environments
-n, --name=<value> Unique name for the environment
COMMON FLAGS
--config=<value> [default: ~/.flowable/cli-config.yml] Path to the config file
--env=<value> Environment name, if not provided, the selected environment will be used
DESCRIPTION
Delete an environment configurationflowable environment get
Get an environment configuration
USAGE
$ flowable environment get -n <value> [--config <value>] [--env <value>]
FLAGS
-n, --name=<value> (required) Unique name for the environment
COMMON FLAGS
--config=<value> [default: ~/.flowable/cli-config.yml] Path to the config file
--env=<value> Environment name, if not provided, the selected environment will be used
DESCRIPTION
Get an environment configurationflowable environment list
List the available environments
USAGE
$ flowable environment list [--config <value>] [--env <value>]
COMMON FLAGS
--config=<value> [default: ~/.flowable/cli-config.yml] Path to the config file
--env=<value> Environment name, if not provided, the selected environment will be used
DESCRIPTION
List the available environmentsflowable export
Export an app from Design
USAGE
$ flowable export [--config <value>] [--env <value>] [-l <value> | -a <value> | -w <value>] [-o <value>]
FLAGS
-a, --app=<value> App key
-l, --library=<value> Custom component library key. It will export the In-App Library app
-o, --output=<value> [default: Your current working directory] Output directory
-w, --workspace=<value> Workspace key
COMMON FLAGS
--config=<value> [default: ~/.flowable/cli-config.yml] Path to the config file
--env=<value> Environment name, if not provided, the selected environment will be used
DESCRIPTION
Export an app from Designflowable import
Import an app to Design
USAGE
$ flowable import -i <value> -w <value> [--config <value>] [--env <value>] [-o | -k]
FLAGS
-i, --input=<value> (required) Input app zip file path
-k, --keepBoth Keep both the old and new app
-o, --override Override the app if it already exists
-w, --workspace=<value> (required) Workspace key
COMMON FLAGS
--config=<value> [default: ~/.flowable/cli-config.yml] Path to the config file
--env=<value> Environment name, if not provided, the selected environment will be used
DESCRIPTION
Import an app to Designflowable login
Authenticate with Flowable
USAGE
$ flowable login [--config <value>] [--env <value>] [--skipDesignLogin] [--skipArtifactoryLogin]
FLAGS
--skipArtifactoryLogin Skip login to Flowable Artifactory. Skip it if you want to use your own npm registry
--skipDesignLogin Skip login to Flowable Design. To only login to artifactory
COMMON FLAGS
--config=<value> [default: ~/.flowable/cli-config.yml] Path to the config file
--env=<value> Environment name, if not provided, the selected environment will be used
DESCRIPTION
Authenticate with Flowableflowable ping
Check the connection with the Flowable services
USAGE
$ flowable ping [--config <value>] [--env <value>]
COMMON FLAGS
--config=<value> [default: ~/.flowable/cli-config.yml] Path to the config file
--env=<value> Environment name, if not provided, the selected environment will be used
DESCRIPTION
Check the connection with the Flowable servicesflowable publish
Publish an app from Design to Work
USAGE
$ flowable publish [--config <value>] [--env <value>] [-l <value> | -a <value> | -w <value>] [-t <value>]
FLAGS
-a, --app=<value> App key
-l, --library=<value> Custom component library key. It will publish the In-App Library app
-t, --targetName=<value> [default: _default] Work target environment name. Example: production
-w, --workspace=<value> Workspace key
COMMON FLAGS
--config=<value> [default: ~/.flowable/cli-config.yml] Path to the config file
--env=<value> Environment name, if not provided, the selected environment will be used
DESCRIPTION
Publish an app from Design to Workflowable components createflowable components initflowable components migrateflowable components register-interactiveflowable components uploadflowable components watchflowable loginflowable login loginflowable pingflowable ping ping
flowable components create
Create a new custom component
USAGE
$ flowable components create
DESCRIPTION
Create a new custom componentflowable components init
Initialize a repository for custom components
USAGE
$ flowable components init [-b]
FLAGS
-b, --onlyBoilerplate
DESCRIPTION
Initialize a repository for custom componentsflowable components migrate
Migrate a custom component from a legacy project
USAGE
$ flowable components migrate
DESCRIPTION
Migrate a custom component from a legacy projectflowable components register-interactive
[Advanced] Register project and/or custom components that already exists
USAGE
$ flowable components register-interactive
DESCRIPTION
[Advanced] Register project and/or custom components that already existsflowable components upload
Build and upload the custom components
USAGE
$ flowable components upload [-v]
FLAGS
-v, --verbose
DESCRIPTION
Build and upload the custom componentsflowable components watch
Start a developing server
USAGE
$ flowable components watch
DESCRIPTION
Start a developing serverflowable login
Authenticate with Flowable
USAGE
$ flowable login
DESCRIPTION
Authenticate with Flowable
ALIASES
$ flowable loginflowable login login
Authenticate with Flowable
USAGE
$ flowable login login
DESCRIPTION
Authenticate with Flowable
ALIASES
$ flowable login