1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
# CLI usage
## Installation
There is two ways to install JoliNotif for a CLI usage.
### Install package globally with Composer
```bash
$ 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](https://github.com/jolicode/JoliNotif/releases):
```bash
curl https://github.com/jolicode/JoliNotif/releases/latest/download/jolinotif.phar && sudo mv jolinotif.phar /usr/local/bin/jolinotif
```
## Usage
```bash
jolinotif --title "Awesome notification" --body "This is quite a cool cross-platform notification!"
```
To get help just run:
```bash
jolinotif --help
```
To output debug information, add the `--verbose` flag:
```bash
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](04-cron-usage.md)
* [Drivers](03-drivers.md)
* [Notification](02-notification.md)
* [Basic usage](01-basic-usage.md)
* [README](../README.md)
|
