|
2 years ago | |
---|---|---|
src | 2 years ago | |
CHANGELOG | 2 years ago | |
LICENSE | 2 years ago | |
Makefile | 2 years ago | |
README.md | 2 years ago |
README.md
cli-assistant
A CLI-based personal assistant
Keep in mind that the software is under development and it's in its alpha stage, and a some features will change over time.
How to use cli-assistant
- Clone this repository
- Navigate to the files of this repository
- Run
make
to compile the software - Run
./assistant
to run the software
How to use cli-assistant
The cli-assistant is supposed to work in a similar way programs like Apple's Siri and Microsoft's Cortana (and other similar applications) work, by typing a question, and according to the question, the assistant will show what you asked for.
cli-assistant
works by detecting a keyword in the input of the user. And various information will appear, according to the detected keyword.
For the voice output, the espeak-ng
package is required.
Keywords
There are 4 available keywords in the software
weather
- It shows the weather in your area.time
- It shows the time.date
- It shows the date.website
- It launches your browser with a requested website.
Flags
There are two flags in the program's code that can be changed (their values can be either 1
or 0
).
VOICE
- It toggles the voice output.DEV
- It toggles the developer mode.
The values can also be disabled when compiling by running make no-voice
or make no-dev
.