○

The open-source language model computer.

We want to help you build. Apply for 1-on-1 support.

---

⚠️ WARNING: This experimental project is under rapid development and lacks basic safeguards. Until a stable 1.0 release, ONLY run this repository on devices without sensitive information or access to paid services. ⚠️

---

The 01 Project is building an open-source ecosystem for AI devices.

Our flagship operating system can power conversational devices like the Rabbit R1, Humane Pin, or Star Trek computer.

We intend to become the GNU/Linux of this space by staying open, modular, and free.

Software

git clone https://github.com/OpenInterpreter/01 # Clone the repository
cd 01/software # CD into the source directory
brew install portaudio ffmpeg cmake # Install Mac OSX dependencies
poetry install # Install Python dependencies

Getting Started

Using OpenAI's API

To use 01 with OpenAI's API, you need to first set your API key.

1. Create a .env file in the 01/software directory.
2. Add OPENAI_API_KEY=<your-api-key> to the file.
3. Run the following command:

poetry run 01

Alternatively, you can set the OPENAI_API_KEY environment variable in your shell with export OPENI_API_KEY=<your-api-key>.

Using a Local Model

To use 01 with a local model, run the following command and follow the prompts:

poetry run 01 --local

Hardware

• The 01 Light is an ESP32-based voice interface. Build instructions are here. It works in tandem with the 01 Server (setup guide below) running on your home computer.
• Mac OSX and Ubuntu are supported by running poetry run 01. This uses your spacebar to simulate the 01 Light.
• (coming soon) The 01 Heavy is a standalone device that runs everything locally.

We need your help supporting & building more hardware. The 01 should be able to run on any device with input (microphone, keyboard, etc.), output (speakers, screens, motors, etc.), and an internet connection (or sufficient compute to run everything locally). Contribution Guide →

What does it do?

The 01 exposes a speech-to-speech websocket at localhost:10001.

If you stream raw audio bytes to / in LMC format, you will receive its response in the same format.

Inspired in part by Andrej Karpathy's LLM OS, we run a code-interpreting language model, and call it when certain events occur at your computer's kernel.

The 01 wraps this in a voice interface:

Protocols

LMC Messages

To communicate with different components of this system, we introduce LMC Messages format, which extends OpenAI’s messages format to include a "computer" role.

Dynamic System Messages

Dynamic System Messages enable you to execute code inside the LLM's system message, moments before it appears to the AI.

# Edit the following settings in i.py
interpreter.system_message = r" The time is {{time.time()}}. " # Anything in double brackets will be executed as Python
interpreter.chat("What time is it?") # It will know, without making a tool/API call

Guides

01 Server

To run the server on your Desktop and connect it to your 01 Light, run the following commands:

brew install ngrok/ngrok/ngrok
ngrok authtoken ... # Use your ngrok authtoken
poetry run 01 --server --expose

The final command will print a server URL. You can enter this into your 01 Light's captive WiFi portal to connect to your 01 Server.

Local Mode

poetry run 01 --local

If you want to run local speech-to-text using Whisper, you must install Rust. Follow the instructions given here.

Customizations

O1 is highly customizable and comes with several ways to modify its behavior, including a config.yaml file, .env file, command-line arguments and the i.py file. Follow the steps below to use these customization options.

1. Use a config.yaml File

To create a config.yaml file, copy the config-template.yaml file in the software directory.

cp config-template.yaml config.yaml

2. Use a .env File

To create a .env file, copy the config-template.env file in the software directory.

cp config-template.env .env

There are two important points to note when using the .env file:

1. Values from the .env file automatically override values from the config.yaml file.
2. 01-specific environment variables use the following pattern: 01_<SECTION>_<KEY>. As an example, to override the local.enabled value from your config.yaml file, use the 01_LOCAL_ENABLED environment variable.

3. Use Command-line Arguments

01 comes with a number of command-line arguments. These simplify certain tasks and can also be used to override values from both the config.yaml and .env files. For a full list of command-line arguments, run the following command:

poetry run 01 --help

4. Edit the i.py File

In i.py, you can edit the system message, model, skills library path and more. This file sets up an interpreter, and is powered by Open Interpreter.

Ubuntu Dependencies

sudo apt-get install portaudio19-dev ffmpeg cmake

Contributors

Please see our contributing guidelines for more details on how to get involved.

Roadmap

Visit our roadmap to see the future of the 01.

Background

Context ↗

The story of devices that came before the 01.

Inspiration ↗

Things we want to steal great ideas from.

○