Mycroft

Mycroft core is no longer maintaiend and probably likely not work on your computer anymore. Open Voice OS and Neon-core are both spiritual successors to Mycroft. (And some of the old code may live on there.) First, get the code on your system! The simplest method is via git (git installation instructions): cd ~/ git clone cd mycroft-core bash dev setup.sh NOTE: The default branch for this repository is 'dev', which should be considered a work-in-progress. If you want to clone a more stable version, switch over to the 'master' branch. Mycroft provides start-mycroft.sh to perform common tasks. This script uses a virtualenv created by dev setup.sh . Assuming you installed mycroft-core in your home directory run: cd ~/mycroft-core ./start-mycroft.sh debug The "debug" command will start the background services (microphone listener, skill, messagebus, and audio subsystems) as well as bringing up a text-based Command Line Interface (CLI) you can use to interact with Mycroft and see the contents of the various logs. Alternatively you can run ./start-mycroft.sh all to begin the services without the command line interface. Later you can bring up the CLI using ./start-mycroft.sh cli . By default, mycroft-core is configured to use Home. By saying "Hey Mycroft, pair my device" (or any other request verbal request) you will be informed that your device needs to be paired. Mycroft will speak a 6-digit code which you can enter into the pairing page within the Mycroft Home site. Once paired, your unit will use Mycroft API keys for services such as Speech-to-Text (STT), weather and various other skills. Mycroft is nothing without skills. There are a handful of default skills that are downloaded automatically to your /opt/mycroft/skills directory, but most need to be installed explicitly. See the Skill Repo to discover skills made by others. Please share your own interesting work! Pairing Information Pairing information generated by registering with Home is stored in: ~/.config/mycroft/identity/identity2.json Configuration Mycroft's configuration consists of 4 possible locations: mycroft-core/mycroft/configuration/mycroft.conf (Defaults) Mycroft Home (Remote) /etc/mycroft/mycroft.conf (Machine) $XDG CONFIG DIR/mycroft/mycroft.conf (which is by default $HOME/.config/mycroft/mycroft.conf ) (USER) When the configuration loader starts, it looks in these locations in this order, and loads ALL configurations. Keys that exist in multiple configuration files will be overridden by the last file to contain the value. This process results in a minimal amount being written for a specific device and user, without modifying default distribution files. If you do not wish to use the Mycroft Home service, before starting Mycroft for the first time, create $HOME/.config/mycroft/mycroft.conf with the following contents: The Mycroft backend provides access to a range of API keys for specific services. Without pairing with the Mycroft backend, you will need to add your own API keys, install a different Skill or Plugin to perform that function, or not have access to that functionality. These are the keys currently used in Mycroft Core through the Mycroft backend: STT API, Google STT, Google Cloud Speech A range of STT services are available for use with Mycroft. Weather Skill API, OpenWeatherMap Wolfram-Alpha Skill NOTE: In order to complete this step, you will need to know the hostname and port for the proxy server. Your network administrator will be able to provide these details. Your network administrator may want information on what type of traffic Mycroft will be using. We use https traffic on port 443 , primarily for accessing ReST-based APIs. If you are using Mycroft behind a proxy without authentication, add the following environment variables, changing the proxy hostname.com and proxy port for the values for your network. These commands are executed from the Linux command line interface (CLI). If you are behind a proxy which requires authenti