flowable-cli

Flowable CLI


* flowable-cli
* Usage
* Commands

Usage

``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
...
`


Commands


* 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

flowable components build

Build custom components

`
USAGE
$ flowable components build [--config ] [--env ] [-v] [--beautify]

FLAGS
-v, --verbose Verbose mode
--beautify Beautify the output (Not minifying it)

COMMON FLAGS
--config= [default: ~/.flowable/cli-config.yml] Path to the config file
--env= Environment name, if not provided, the selected environment will be used

DESCRIPTION
Build custom components
`

flowable components create

Create a new custom component

`
USAGE
$ flowable components create [--config ] [--env ]

COMMON FLAGS
--config= [default: ~/.flowable/cli-config.yml] Path to the config file
--env= Environment name, if not provided, the selected environment will be used

DESCRIPTION
Create a new custom component
`

flowable components doctor

Check the custom components project

`
USAGE
$ flowable components doctor [--config ] [--env ]

COMMON FLAGS
--config= [default: ~/.flowable/cli-config.yml] Path to the config file
--env= Environment name, if not provided, the selected environment will be used

DESCRIPTION
Check the custom components project
`

flowable components init

Initialize a repository for custom components

`
USAGE
$ flowable components init [--config ] [--env ] [-b] [-n ]

FLAGS
-b, --onlyBoilerplate
-n, --name=

COMMON FLAGS
--config= [default: ~/.flowable/cli-config.yml] Path to the config file
--env= Environment name, if not provided, the selected environment will be used

DESCRIPTION
Initialize a repository for custom components
`

flowable components types

Generate typescript types for a custom component properties

`
USAGE
$ flowable components types [--config ] [--env ]

COMMON FLAGS
--config= [default: ~/.flowable/cli-config.yml] Path to the config file
--env= Environment name, if not provided, the selected environment will be used

DESCRIPTION
Generate typescript types for a custom component properties
`

flowable components upload

Upload the custom components

`
USAGE
$ flowable components upload [--config ] [--env ] [--build-dir ] [--draft | --minor | --major |
--patch | --version ]

FLAGS
--build-dir= 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= Version to upload (e.g. 1.0.0)

COMMON FLAGS
--config= [default: ~/.flowable/cli-config.yml] Path to the config file
--env= Environment name, if not provided, the selected environment will be used

DESCRIPTION
Upload the custom components
`

flowable components watch

Start a developing server

`
USAGE
$ flowable components watch [--config ] [--env ] [--ignore-config] [-v]

FLAGS
-v, --verbose Verbose mode
--ignore-config Ignore project configuration

COMMON FLAGS
--config= [default: ~/.flowable/cli-config.yml] Path to the config file
--env= Environment name, if not provided, the selected environment will be used

DESCRIPTION
Start a developing server
`

flowable deploy

You can deploy an app zip file or a build output from a custom components library

`
USAGE
$ flowable deploy -i [--config ] [--env ]

FLAGS
-i, --input= (required) [default: ./dist] Input app zip file path or a build directory path

COMMON FLAGS
--config= [default: ~/.flowable/cli-config.yml] Path to the config file
--env= 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 Work
`

flowable environment add

Add or update an environment configuration

`
USAGE
$ flowable environment add -n -t design|work -b -p [--config ] [--env ]

FLAGS
-b, --baseUrl= (required) Base URL for the environment
-n, --name= (required) Unique name for the environment
-p, --token= (required) Access token for the environment
-t, --type= (required) Type of the environment


COMMON FLAGS
--config= [default: ~/.flowable/cli-config.yml] Path to the config file
--env= Environment name, if not provided, the selected environment will be used

DESCRIPTION
Add or update an environment configuration
`

flowable environment delete

Delete an environment configuration

`
USAGE
$ flowable environment delete [--config ] [--env ] [-n ] [-a]

FLAGS
-a, --all Delete all environments
-n, --name= Unique name for the environment

COMMON FLAGS
--config= [default: ~/.flowable/cli-config.yml] Path to the config file
--env= Environment name, if not provided, the selected environment will be used

DESCRIPTION
Delete an environment configuration
`

flowable environment get

Get an environment configuration

`
USAGE
$ flowable environment get -n [--config ] [--env ]

FLAGS
-n, --name= (required) Unique name for the environment

COMMON FLAGS
--config= [default: ~/.flowable/cli-config.yml] Path to the config file
--env= Environment name, if not provided, the selected environment will be used

DESCRIPTION
Get an environment configuration
`

flowable environment list

List the available environments

`
USAGE
$ flowable environment list [--config ] [--env ]

COMMON FLAGS
--config= [default: ~/.flowable/cli-config.yml] Path to the config file
--env= Environment name, if not provided, the selected environment will be used

DESCRIPTION
List the available environments
`

flowable export

Export an app from Design

`
USAGE
$ flowable export [--config ] [--env ] [-l | -a | -w ] [-o ]

FLAGS
-a, --app= App key
-l, --library= Custom component library key. It will export the In-App Library app
-o, --output= [default: Your current working directory] Output directory
-w, --workspace= Workspace key

COMMON FLAGS
--config= [default: ~/.flowable/cli-config.yml] Path to the config file
--env= Environment name, if not provided, the selected environment will be used

DESCRIPTION
Export an app from Design
`

flowable import

Import an app to Design

`
USAGE
$ flowable import -i -w [--config ] [--env ] [-o | -k]

FLAGS
-i, --input= (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= (required) Workspace key

COMMON FLAGS
--config= [default: ~/.flowable/cli-config.yml] Path to the config file
--env= Environment name, if not provided, the selected environment will be used

DESCRIPTION
Import an app to Design
`

flowable login

Authenticate with Flowable

`
USAGE
$ flowable login [--config ] [--env ] [--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= [default: ~/.flowable/cli-config.yml] Path to the config file
--env= Environment name, if not provided, the selected environment will be used

DESCRIPTION
Authenticate with Flowable
`

flowable ping

Check the connection with the Flowable services

`
USAGE
$ flowable ping [--config ] [--env ]

COMMON FLAGS
--config= [default: ~/.flowable/cli-config.yml] Path to the config file
--env= Environment name, if not provided, the selected environment will be used

DESCRIPTION
Check the connection with the Flowable services
`

flowable publish

Publish an app from Design to Work

`
USAGE
$ flowable publish [--config ] [--env ] [-l | -a | -w ] [-t ]

FLAGS
-a, --app= App key
-l, --library= Custom component library key. It will publish the In-App Library app
-t, --targetName= [default: _default] Work target environment name. Example: production
-w, --workspace= Workspace key

COMMON FLAGS
--config= [default: ~/.flowable/cli-config.yml] Path to the config file
--env= Environment name, if not provided, the selected environment will be used

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

flowable components create

Create a new custom component

`
USAGE
$ flowable components create

DESCRIPTION
Create a new custom component
`

flowable components init

Initialize a repository for custom components

`
USAGE
$ flowable components init [-b]

FLAGS
-b, --onlyBoilerplate

DESCRIPTION
Initialize a repository for custom components
`

flowable components migrate

Migrate a custom component from a legacy project

`
USAGE
$ flowable components migrate

DESCRIPTION
Migrate a custom component from a legacy project
`

flowable 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 exists
`

flowable components upload

Build and upload the custom components

`
USAGE
$ flowable components upload [-v]

FLAGS
-v, --verbose

DESCRIPTION
Build and upload the custom components
`

flowable components watch

Start a developing server

`
USAGE
$ flowable components watch

DESCRIPTION
Start a developing server
`

flowable login

Authenticate with Flowable

`
USAGE
$ flowable login

DESCRIPTION
Authenticate with Flowable

ALIASES
$ flowable login
`

flowable login login

Authenticate with Flowable

`
USAGE
$ flowable login login

DESCRIPTION
Authenticate with Flowable

ALIASES
$ flowable login
``