Skip to content
Cross-platform CLI utility command for sending notifications using well-known or modern communication services
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
gradle/wrapper Upgrade Gradle wrapper Mar 14, 2019
yfiton-api Initial import Jan 10, 2016
yfiton-cli Bump dependencies May 11, 2017
yfiton-core Catch ServiceConfigurationError for allowing valid notifiers to load May 11, 2017
yfiton-notifiers Fix unchecked type Mar 14, 2019
yfiton-oauth Add missing return description Mar 14, 2019
.gitignore Add Gradle wrapper Apr 13, 2017
.travis.yml Use JDK 11 with travis Mar 14, 2019
LICENSE.txt Initial import Jan 10, 2016
README.md Update README.md Jul 15, 2018
build.gradle Bump dependencies May 11, 2017
gradle.properties [Gradle Release Plugin] - new version commit: '1.0.1-SNAPSHOT'. Mar 14, 2019
gradlew Upgrade Gradle wrapper Mar 14, 2019
gradlew.bat Upgrade Gradle wrapper Mar 14, 2019
settings.gradle Initial import Jan 10, 2016

README.md

Yfiton

CircleCI BrowserStack Status

Yfiton is an API and command-line utility to send notifications using well-known or modern communication services.

Installation

You can download one of the distributions from the releases section.

Once unpacked, the folder associated to the distribution is referred to as YFITON_HOME.

For running Yfiton, add YFITON_HOME/bin to your PATH environment variable.

Then, to check if Yfiton is properly installed, type yfiton --version.

Basic usage

Triggering beep(s) using default speaker:

$ yfiton -n beep
$ yfiton -n beep -Ppattern="*** ** *"

Displaying rich desktop notification(s):

$ yfiton -n desktop -Pmessage="Lunch time!"
$ yfiton -n desktop -Pmessage="Lunch time!" -PhideAfter=10 -Pposition=TOP_RIGHT

Sending an email:

$ yfiton -n email -Phost=smtp.free.fr -Pfrom=username@free.fr -Pto=user@company.com \
    -Psubject="Build failure!" -Pbody="Build #42 has failed!" -Pusername=username@free.fr

Publishing a message on Facebook:

$ yfiton -n facebook -Pmessage="I have bougth the new Xbox Elite controller. Incredible!"
$ yfiton -n facebook -Pmessage="My new puzzle!" -Pphoto=path/to/your/photo.jpg

Pushing a notification with Pushbullet:

$ yfiton -n pushbullet -Ptitle="Weather alert!" -Pbody="Hurricane approaches"
$ yfiton -n pushbullet -Pbody="Please find report" -Pfile=path/to/file.extension
$ yfiton -n pushbullet -Pbody="New daily deal" -Purl="https://www.groupon.com"

Sending notification to Slack:

$ yfiton -n slack -Pmessage="Quick design session at 2pm"
$ yfiton -n slack -Pmessage="1 2 3 soleil!" -Pchannel=#random

Updating Twitter status:

$ yfiton -n twitter -Pstatus="5 Tips for Growing Your Business http://bit.ly/1PjsefI #marketing"

Advanced usage

Yfiton is provided with several notifiers that allow sending notifications using well-known or modern communication services. You can list available notifiers as follows:

$ yfiton --list-notifiers

A notifier is identified by a unique name. For instance, Facebook notifier has unique identifier facebook. It is possible to describe available parameters for Facebook notifier as below:

$ yfiton --describe-notifier facebook

Most of the notifiers require to connect to a third-party service. Authentication parameters are stored by default in $HOME/.yfiton.

License

Yfiton is released under Apache Software Foundation License v2.0. See LICENSE file included for more details.

Acknowledgements

You can’t perform that action at this time.