Skip to content

CLI Usage

Pouya Eghbali edited this page Jul 7, 2021 · 5 revisions

The please command

Please accepts a few arguments, that affect how it manages its software repository, how it runs your commands or how it installs them:

please <command>

command to run

Commands:
  please <command>     command to run                                  [default]
  please completion    generate completion script

Options:
      --version         Show version number                            [boolean]
      --help            Show help                                      [boolean]
  -u, --update          Enable repo updates                            [boolean]
  -l, --log             Log level verbosity                             [number]
  -S, --silent          Mute all messages                              [boolean]
  -V, --verbose         Log all messages                               [boolean]
  -s, --silent-run      Run command silently                           [boolean]
  -I, --silent-install  Silence install logs                           [boolean]
  -a, --allow-unsafe    Allow unsafe installs                          [boolean]

To enable a flag, simply provide it to the please command:

please --silent git clone ...

To disable a flag, you can either do:

please --silent-install=false git clone ...

Or prefix it with no:

please --no-silent-install git clone ...

You can set default values for these arguments in the please configuration file.

Log levels

Please supports five log levels:

Level Description
0 Nothing at all
1 Show only error messages
2 Show error messages, as well as warnings
3 Show error messages, warnings, and important information
4 Show all messages, even unimportant ones

Default log level is 1. Note that log levels are for internal please specific messages, they do not affect installation messages or the output of the running command, to control those you should use silent-install or silent-run flags.

The silent flag sets the log level to 1, the verbose flag sets it to 4.

User's guide

Home
CLI Usage
Configuration
CNF
FAQ

Developer's guide

Repository
Please API

Clone this wiki locally