@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/2.4.0 darwin-x64 node-v12.18.3
$ liteflow --help [COMMAND]
USAGE
  $ liteflow COMMAND
...

Commands

• liteflow deploy [PATH]
• liteflow dev [PATH]
• liteflow help [COMMAND]
• liteflow init PATH
• liteflow login
• liteflow logout
• liteflow service:doc [SERVICE_PATH]
• liteflow service:init DIR

liteflow deploy [PATH]

Deploy an application

USAGE
  $ liteflow deploy [PATH]

ARGUMENTS
  PATH  [default: ./] Path of your application

OPTIONS
  --confirm          Confirm the deployment
  --project=project  Id of your project

See code: src/commands/deploy.ts

liteflow dev [PATH]

Start a dev environment for your application

USAGE
  $ liteflow dev [PATH]

ARGUMENTS
  PATH  [default: ./] Path of your application

See code: src/commands/dev.ts

liteflow help [COMMAND]

display help for liteflow

USAGE
  $ liteflow help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

liteflow init PATH

Create a new application

USAGE
  $ liteflow init PATH

ARGUMENTS
  PATH  Path of your application

See code: src/commands/init.ts

liteflow login

Login to your account

USAGE
  $ liteflow login

OPTIONS
  --email=email
  --password=password

See code: src/commands/login.ts

liteflow logout

Logout from your account

USAGE
  $ liteflow logout

See code: src/commands/logout.ts

liteflow service:doc [SERVICE_PATH]

Generate documentation for service and print it to stdout

USAGE
  $ liteflow service:doc [SERVICE_PATH]

ARGUMENTS
  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

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:

alias liteflow-dev="LITEFLOW_API_ENDPOINT=http://localhost:3000 LITEFLOW_ANALYTICS_DISABLED=true /PATH/TO/liteflow-js/packages/cli/bin/run"

Then source the modified file to take it account:

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

Use the alias from any path:

liteflow-dev