Skip to content

Command line usage

Most used commands

List pipelines from your config file.

(debug): You can use this command to lint your config file.

sh
pipelight ls
# to
pipelight ls -vvvv
pipelight ls
# to
pipelight ls -vvvv

Inspect and pretty print your pipeline definitions.

sh
pipelight inspect <pipeline_name>
# same as
pipelight ls -vvv <pipeline_name>
pipelight inspect <pipeline_name>
# same as
pipelight ls -vvv <pipeline_name>

Without an argument inspect shows an interactive prompt with your pipeline names.

[g@ku ~]

> deploy_to_host
test
build

Run a pipeline in the background (default).

sh
pipelight run <pipeline_name>
pipelight run <pipeline_name>

Without an argument run shows an interactive prompt with your pipeline names.

[g@ku ~]

> deploy_to_host
test
build

Compulsively check pipelines execution states, and produced outputs.

sh
pipelight logs
# or
pipelight logs -vvv
pipelight logs
# or
pipelight logs -vvv

Clean log folder. Remove logs.

sh
pipelight logs rm
pipelight logs rm

Abort a pipeline execution.

sh
pipelight stop <pipeline_name>
pipelight stop <pipeline_name>

Other useful commands

Discover some options by using the help flag.

sh
pipelight --help
pipelight --help

Can be used on subcommands too.

sh
pipelight run --help
pipelight run --help