@liteflow/cli

@liteflow/cli

CLI for liteflow.

• @liteflow/cli
• Usage
• Commands
• Development

Usage

$ npm install -g @liteflow/cli
$ liteflow COMMAND
running command...
$ liteflow (-v|--version|version)
@liteflow/cli/5.0.0 darwin-x64 node-v12.18.3
$ liteflow --help [COMMAND]
USAGE
  $ liteflow COMMAND
...

Commands

• liteflow deploy
• liteflow help [COMMAND]
• liteflow login
• liteflow logout
• liteflow logs
• liteflow service:create BASE_URL [SERVICE_PATH]
• liteflow service:doc [BASE_URL] [SERVICE_PATH]
• liteflow service:init DIR

liteflow deploy

Deploy an application

Deploy an application

USAGE
  $ liteflow deploy

OPTIONS
  --confirm          Confirm the deployment
  --dry-run          compile and display the workflows
  --project=project  Id of your project

See code: src/commands/deploy.ts

liteflow help [COMMAND]

display help for liteflow

display help for <%= config.bin %>

USAGE
  $ liteflow help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

liteflow login

Login to your account

Login to your account

USAGE
  $ liteflow login

OPTIONS
  --email=email
  --password=password

See code: src/commands/login.ts

liteflow logout

Logout from your account

Logout from your account

USAGE
  $ liteflow logout

See code: src/commands/logout.ts

liteflow logs

Logs executions of your application in real-time

Logs executions of your application in real-time

USAGE
  $ liteflow logs

OPTIONS
  --project=project  Id of your project

See code: src/commands/logs.ts

liteflow service:create BASE_URL [SERVICE_PATH]

Create a service

Create a service

USAGE
  $ liteflow service:create BASE_URL [SERVICE_PATH]

ARGUMENTS
  BASE_URL      Base url where this service will be accessible. (eg: https://service.com)
  SERVICE_PATH  [default: ./] Path of a service

OPTIONS
  --confirm  Confirm the deployment
  --dry-run  compile and display the service

See code: src/commands/service/create.ts

liteflow service:doc [BASE_URL] [SERVICE_PATH]

Generate documentation for service and print it to stdout

Generate documentation for service and print it to stdout

USAGE
  $ liteflow service:doc [BASE_URL] [SERVICE_PATH]

ARGUMENTS
  BASE_URL      Base url where this service will be accessible. (eg: https://service.com)
  SERVICE_PATH  [default: ./] Path of a service

OPTIONS
  -s, --save  Save to default readme file

See code: src/commands/service/doc.ts

liteflow service:init DIR

Initialize a service from a template

Initialize a service from a template

USAGE
  $ liteflow service:init DIR

ARGUMENTS
  DIR  Directory to initialize a service into

OPTIONS
  -t, --template=javascript|typescript  Specify the template to use

See code: src/commands/service/init.ts

Development

Alias

You can create an alias to easily run the local version of the CLI with different env variable.

Add the following line to your ~/.zshrc or ~/.bashrc:

export LITEFLOW_CLI_BIN="REPLACE_BY_PATH_TO/liteflow-js/packages/cli/bin/run"
alias liteflow-dev="LITEFLOW_ANALYTICS_DISABLED=true $LITEFLOW_CLI_BIN"

Then source the modified file to take it account:

source ~/.zshrc # or: source ~/.bashrc

Use the alias from any path:

liteflow-dev