01/README.md

○

Official pre-release repository for The 01 Project.

11 days remaining until launch

View task list ↗

Install dependencies:

# MacOS
brew install portaudio ffmpeg cmake

# Ubuntu
sudo apt-get install portaudio19-dev ffmpeg cmake

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

Setup for usage (experimental):

pip install 01OS

Run the 01 end-to-end:

01 # This will run a server + attempt to determine and run a client.
# (Behavior can be modified by changing the contents of `.env`)

Expose an 01 Server Publicly

We currently support exposing the 01 server publicly via a couple of different tunnel services:

• bore.pub (GitHub)

  • Requirements: Ensure that Rust is installed (Rust Installation), then run:

    cargo install bore-cli
    

  • To Expose:

    01 --server --expose-with-bore
    

• localtunnel (GitHub)

  • Requirements: Ensure that Node.js is installed (Node.js Download), then run:

    npm install -g localtunnel
    

  • To Expose:

    01 --server --expose-with-localtunnel
    

• ngrok (Website)

  • Requirements: Install ngrok (Getting Started with ngrok), and set up an ngrok account. Get your auth key from ngrok dashboard, then set it in your local configuration by running:

    ngrok config add-authtoken your_auth_token_here
    

  • To Expose:

    01 --server --expose-with-ngrok
    

Run a specific client:

01 --client macos # Options: macos, rpi

Run locally:

The current default uses OpenAI's services.

The --local flag will install and run the whisper.cpp STT and Piper TTS models.

01 --local # Local client and server
01 --local --server --expose-with-bore  # Expose the local server with a public tunnel

Teach Mode (experimental)

Running 01 --teach runs 01 in teach mode, where you can add your own skills for Open Interpreter to use, through an easy-to-follow GUI.

Setup for development:

# Clone the repo, cd into the 01OS directory
git clone https://github.com/KillianLucas/01.git
cd 01OS

# Install dependencies, run the commands above
poetry install
poetry run 01

Configuration:

Copy the 01OS/.env.example file to 01OS/.env then configure the environment variables within the file.

Background

Context ↗

The story of devices that came before the 01.

Inspiration ↗

Things we want to steal great ideas from.

Direction

Goals ↗

What we're going to do.

Use Cases ↗

What the 01 will be able to do.