09/04/2018 jarvis/README.

md at master · alexylem/jarvis · GitHub

alexylem / jarvis

Branch: master jarvis / README.md Find file Copy path

Oliv4945 Update version number 6b6a606 on 3 Jan

3 contributors

80 lines (64 sloc) 2.91 KB

Jarvis version 18.01.03 build passing plugins 81+

Overview & full documentation available on http://openjarvis.com/

Jarvis.sh is a lightweight configurable multi-lang voice assistant

Meant for home automation running on slow computers (ex: Raspberry Pi)
Installs automatically voice recognition & speech synthesis egines of your choice
Highly extendable thanks to a wide catalog of community plugins

Languages supported (for voice recognition and speech synthesis):

Installation
See Requirements.

$> git clone https://github.com/alexylem/jarvis.git

$> cd jarvis/
$> ./jarvis.sh -i

More info on the site installation page.

Usage

$> jarvis

https://github.com/alexylem/jarvis/blob/master/README.md 1/3
09/04/2018 jarvis/README.md at master · alexylem/jarvis · GitHub

Command-line options

$> jarvis -h
Main options are accessible through the application menu

-b run in background (no menu, continues after terminal is closed)

-c overrides conversation mode setting (true/false)
-i install and setup wizard
-h display this help
-j output in JSON (for APIs)
-k directly start in keyboard mode
-l directly listen for one command (ex: launch from physical button)
-m mute mode (overrides settings)
-n directly start jarvis without menu
-p install plugin, ex: jarvis -p https://github.com/alexylem/jarvis-time
-q quit jarvis if running in background
-r uninstall jarvis and its dependencies
-s just say something and exit, ex: jarvis -s 'hello world'
-u force update Jarvis and plugins (ex: use in cron)
-v troubleshooting mode
-w no colors in output
   -x execute order, ex: jarvis -x "switch on lights"

Support
http://openjarvis.com/content/support

License
license MIT

https://github.com/alexylem/jarvis/blob/master/README.md 2/3
09/04/2018 jarvis/README.md at master · alexylem/jarvis · GitHub

https://github.com/alexylem/jarvis/blob/master/README.md 3/3