A free and open source personal assistant
 
 
Go to file
getimiskon 8906aad658 Code refactoring 2021-06-30 22:42:12 +03:00
src Code refactoring 2021-06-30 22:42:12 +03:00
CHANGELOG Added CHANGELOG 2021-06-17 00:49:40 +03:00
LICENSE Code update 2021-04-11 03:13:42 +03:00
Makefile Makefile update 2021-06-17 00:50:09 +03:00
README.md Code update 2021-04-11 03:13:42 +03:00

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

  1. Clone this repository
  2. Navigate to the files of this repository
  3. Run make to compile the software
  4. 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

  1. weather - It shows the weather in your area.
  2. time - It shows the time.
  3. date - It shows the date.
  4. 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).

  1. VOICE - It toggles the voice output.
  2. DEV - It toggles the developer mode.

The values can also be disabled when compiling by running make no-voice or make no-dev.