05-cli-usage.md

CLI usage

Installation

There is two ways to install JoliNotif for a CLI usage.

Install package globally with Composer

$ composer global require jolicode/jolinotif

Note Make sure to place the ~/.composer/vendor/bin directory (or the equivalent directory for your OS) in your PATH so the transfer executable can be located by your system. Simply add this directory to your PATH in your ~/.bashrc (or ~/.bash_profile) like this:

$ echo "export PATH=~/.composer/vendor/bin:$PATH" >> ~/.bashrc
$ source ~/.bashrc

Download the PHAR executable

You can download the latest version of JoliNotif as a PHAR file from the releases page:

curl https://github.com/jolicode/JoliNotif/releases/latest/download/jolinotif.phar && sudo mv jolinotif.phar /usr/local/bin/jolinotif

Usage

jolinotif --title "Awesome notification" --body "This is quite a cool cross-platform notification!"

To get help just run:

jolinotif --help

To output debug information, add the --verbose flag:

jolinotif --title "..." --body "..." --verbose

In case of troubles use following format for passing the param: --param="value".
For required params (title, body) equality sign and quotes can be omitted.

Next readings

Previous pages:

• CRON usage
• Drivers
• Notification
• Basic usage
• README