Flowable CLI
Flowable CLI



* flowable-cli
* Usage
* Commands
``sh-session`
$ 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
...
* flowable components build
* flowable components create
* flowable components doctor
* flowable components init
* flowable components types
* flowable components upload
* flowable components watch
* flowable deploy
* flowable environment add
* flowable environment delete
* flowable environment get
* flowable environment list
* flowable export
* flowable import
* flowable login
* flowable ping
* flowable publish
Build custom components
`
USAGE
$ flowable components build [--config
FLAGS
-v, --verbose Verbose mode
--beautify Beautify the output (Not minifying it)
COMMON FLAGS
--config=
--env=
DESCRIPTION
Build custom components
`
Create a new custom component
`
USAGE
$ flowable components create [--config
COMMON FLAGS
--config=
--env=
DESCRIPTION
Create a new custom component
`
Check the custom components project
`
USAGE
$ flowable components doctor [--config
COMMON FLAGS
--config=
--env=
DESCRIPTION
Check the custom components project
`
Initialize a repository for custom components
`
USAGE
$ flowable components init [--config
FLAGS
-b, --onlyBoilerplate
-n, --name=
COMMON FLAGS
--config=
--env=
DESCRIPTION
Initialize a repository for custom components
`
Generate typescript types for a custom component properties
`
USAGE
$ flowable components types [--config
COMMON FLAGS
--config=
--env=
DESCRIPTION
Generate typescript types for a custom component properties
`
Upload the custom components
`
USAGE
$ flowable components upload [--config
--patch | --version
FLAGS
--build-dir=
--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=
COMMON FLAGS
--config=
--env=
DESCRIPTION
Upload the custom components
`
Start a developing server
`
USAGE
$ flowable components watch [--config
FLAGS
-v, --verbose Verbose mode
--ignore-config Ignore project configuration
COMMON FLAGS
--config=
--env=
DESCRIPTION
Start a developing server
`
You can deploy an app zip file or a build output from a custom components library
`
USAGE
$ flowable deploy -i
FLAGS
-i, --input=
COMMON FLAGS
--config=
--env=
DESCRIPTION
You can deploy an app zip file or a build output from a custom components library
Deploy an app to Work
`
Add or update an environment configuration
`
USAGE
$ flowable environment add -n
FLAGS
-b, --baseUrl=
-n, --name=
-p, --token=
-t, --type=
COMMON FLAGS
--config=
--env=
DESCRIPTION
Add or update an environment configuration
`
Delete an environment configuration
`
USAGE
$ flowable environment delete [--config
FLAGS
-a, --all Delete all environments
-n, --name=
COMMON FLAGS
--config=
--env=
DESCRIPTION
Delete an environment configuration
`
Get an environment configuration
`
USAGE
$ flowable environment get -n
FLAGS
-n, --name=
COMMON FLAGS
--config=
--env=
DESCRIPTION
Get an environment configuration
`
List the available environments
`
USAGE
$ flowable environment list [--config
COMMON FLAGS
--config=
--env=
DESCRIPTION
List the available environments
`
Export an app from Design
`
USAGE
$ flowable export [--config
FLAGS
-a, --app=
-l, --library=
-o, --output=
-w, --workspace=
COMMON FLAGS
--config=
--env=
DESCRIPTION
Export an app from Design
`
Import an app to Design
`
USAGE
$ flowable import -i
FLAGS
-i, --input=
-k, --keepBoth Keep both the old and new app
-o, --override Override the app if it already exists
-w, --workspace=
COMMON FLAGS
--config=
--env=
DESCRIPTION
Import an app to Design
`
Authenticate with Flowable
`
USAGE
$ flowable login [--config
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=
--env=
DESCRIPTION
Authenticate with Flowable
`
Check the connection with the Flowable services
`
USAGE
$ flowable ping [--config
COMMON FLAGS
--config=
--env=
DESCRIPTION
Check the connection with the Flowable services
`
Publish an app from Design to Work
`
USAGE
$ flowable publish [--config
FLAGS
-a, --app=
-l, --library=
-t, --targetName=
-w, --workspace=
COMMON FLAGS
--config=
--env=
DESCRIPTION
Publish an app from Design to Work
`
- flowable components create
- flowable components init
- flowable components migrate
- flowable components register-interactive
- flowable components upload
- flowable components watch
- flowable login
- flowable login login
- flowable ping
- flowable ping ping
Create a new custom component
`
USAGE
$ flowable components create
DESCRIPTION
Create a new custom component
`
Initialize a repository for custom components
`
USAGE
$ flowable components init [-b]
FLAGS
-b, --onlyBoilerplate
DESCRIPTION
Initialize a repository for custom components
`
Migrate a custom component from a legacy project
`
USAGE
$ flowable components migrate
DESCRIPTION
Migrate a custom component from a legacy project
`
[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 exists
`
Build and upload the custom components
`
USAGE
$ flowable components upload [-v]
FLAGS
-v, --verbose
DESCRIPTION
Build and upload the custom components
`
Start a developing server
`
USAGE
$ flowable components watch
DESCRIPTION
Start a developing server
`
Authenticate with Flowable
`
USAGE
$ flowable login
DESCRIPTION
Authenticate with Flowable
ALIASES
$ flowable login
`
Authenticate with Flowable
`
USAGE
$ flowable login login
DESCRIPTION
Authenticate with Flowable
ALIASES
$ flowable login
``