Skip to main content
Version: 1.0.0-beta.7+dev

Introduction

What is Leon?#

Leon is an open-source personal assistant who can live on your server.

He does stuff when you ask him to.

You can talk to him and he can talk to you. You can also text him and he can also text you. If you want to, Leon can communicate with you by being offline to protect your privacy.

You can think of him as a second brain.

Tip

Leon is still pretty young today. If you wish, you can help by contributing ❤️

Demo#

A video is available here.

Motivations#

  1. As developers (or not), we love creating things, even more when those things can help in our daily life. So instead of building a dedicated project for each of those things, Leon can help us with his packages/modules (skills) structure. We believe it's better than keeping your awesome ideas in backlog forever, right?
  2. With this generic structure, everyone can create their own modules and share them. Therefore there is only one core (to rule them all).
  3. Leon uses AI concepts, which is cool.
  4. Privacy matters, you can configure Leon to talk with him offline. You can already interact with him without any third party services.
  5. Last but not least: open source is great.

Try with a Single-Click#

Gitpod will automatically setup an environment and run an instance for you.

Open in Gitpod

Installation#

Prerequisites#

  • Git
  • Node.js >= 16

    Leon's core is developed on the top of the Node.js JavaScript runtime.

  • npm >= 8

    npm is the packages manager of Node.js, Leon needs it for his core's dependencies tree.

Tip

You can read the How To section to install these prerequisites.

Install the Leon CLI#

The Leon CLI is the companion that will help with your journey by making the setup very smooth and more! Let's install the Leon CLI by running the following command:

npm install --global @leon-ai/cli

Install Leon#

Now that the CLI is installed, you can give birth to Leon:

leon create birth

By default, the CLI grabs the source code from the stable Git branch (master). Instead, you can also pull the source code from the develop Git branch which is the default branch and this is where the latest changes are merged. On this branch you will get the latest changes in advance but be aware that it will not be as stable as the master one:

leon create birth --develop

Run Leon#

At this stage, Leon is born and can already start to run via this command:

leon start

Basically on that level you can already communicate with him by text and ask him to do things.

Tip

To see what he can do, please refer to the packages list.