How to get started?

Want to give Mycroft a try? Mycroft is open source software that runs where you want it to, whether it’s on your own hardware or one of our dedicated devices.

Jump to:

Buy
Download
Community Releases
Setup

Buy

Get a voice assistant device with no hassle. Plug in, connect to WiFi and go.

Mycroft Mark II

Mark II

Mark II is the next incarnation of Mycroft. It sports a 4-inch display to accompany the voice interaction with a visual interface. Microphone and speaker components have also been updated. Best for those who want a ‘works out of the box’ solution.

Pre-order your Mark II

Mark I

Mark I is a no-fuss way to get started. It has been designed specifically to work with Mycroft’s capabilities as a standalone device. Great for those who aren’t super technical, but it can be easily extended, altered, modified, and hacked.

Buy Mark I

Sold out. If you already own a Mark 1 and want a fast update to the latest release, you can download the latest SD card image here.

Download

You can download Mycroft and run it on your own hardware.

Picroft

Picroft is specifically packaged to run on a Raspberry Pi 3 or 4. It is built on top of the official Raspbian Buster Lite and is available as a disk image ready to be burned to a microSD card.

Get started with Picroft

Linux

If you are a technical user, run Mycroft on your favorite Linux distro, including Ubuntu/Debian, Arch, and Fedora. Clone the repository and run the included setup script.

Get Mycroft for Linux

Community Releases

Our open-source Community have contributed and maintain new ways to use Mycroft.

Android

Build Mycroft in Android Studio and deploy to your Android devices. We have source code available if you’re comfortable with Android Studio and have the skill set to compile this into an .apk and load onto an Android device. Strictly for geeks.

Build Mycroft for Android

Windows and macOS

We’re not quite ready to release Mycroft natively for Windows and macOS. If you are keen to help and have technical experience on these platforms, please let us know!

However you can run Mycroft on MacOS and Windows inside a virtual machine using VirtualBox.

Setup Mycroft using VirtualBox

KDE Plasmoid

If your Linux OS runs the KDE Plasma desktop environment, you can install the Mycroft Plasmoid – a graphical extension for Plasma.

Download Plasmoid
Docker Logo

Docker

Run Mycroft in a Docker container. This can be installed using our pre-built image from Docker Hub, or by building the image manually.

Setup Mycroft for Docker

Setup

You have a device, now let’s set it up!

Chances are someone has run into a similar problem before so you may also find your solution on the Forum, or just ask in our Chat.

1. Create Account

To create an account, visit home.mycroft.ai. Mycroft Home is where you manage your devices and install new Skills.

Create Account

2. Install and Pair

A. If you have a Mark II, follow the instructions in the booklet that was included in your box and see the detailed documentation here.

B. If you have Mark I, the original guide delivered in the box is available here in PDF.

C. To install Mycroft on your own hardware, follow the instructions for Picroft, Linux, or Android.

Mycroft devices need to be paired with your Mycroft Home account to work. During the device setup, your Mycroft should give you a 6-letter pairing code. Pairing your account gives your device details such as your general location – for Skills like weather – and your preferences for measurements such as temperature. It also lets you connect to 3rd party services securely and privately.

Pair My Device

3. Use

To talk to Mycroft, just say Hey Mycroft followed by your request. For instance Hey Mycroft, what time is it? You can try asking things like:

  • Hey Mycroft, what’s the weather like?
  • Hey Mycroft, tell me about dinosaurs.
  • Hey Mycroft, set a timer for 5 minutes.
  • Hey Mycroft, play the news.
  • Hey Mycroft, what’s a conundrum?

To stop Mycroft, just say Hey Mycroft, stop.

4. Contribute

Mycroft is a collaborative project and we want your help to shape it! There are many ways you can contribute depending on your skills, interests, and availability.

Contribute