01/01OS
Tom Chapin 70734561e3 Merge branch 'main' into feature/replace-ngrok-with-open-source
# Conflicts:
#	01OS/.env.example
#	01OS/poetry.lock
#	01OS/pyproject.toml
2024-02-20 14:41:23 -08:00
..
01OS Merge branch 'main' into feature/replace-ngrok-with-open-source 2024-02-20 14:41:23 -08:00
.cursorignore configuring cursor to ignore archive and other random files 2024-02-17 18:42:12 -08:00
.env.example Merge branch 'main' into feature/replace-ngrok-with-open-source 2024-02-20 14:41:23 -08:00
README.md Updating readme with more info about localtunnel 2024-02-17 22:34:17 -08:00
poetry.lock Some fixes 2024-02-19 03:19:52 -08:00
pyproject.toml Some fixes 2024-02-19 03:19:52 -08:00
start.py Bug fixes, CTRL-C fix, relative script fixes, less print statements 2024-02-15 12:36:08 -08:00
start.sh Merge branch 'main' into feature/replace-ngrok-with-open-source 2024-02-20 14:41:23 -08:00
tunnel.sh Merge branch 'main' into feature/replace-ngrok-with-open-source 2024-02-20 14:41:23 -08:00

README.md

The open-source language model computer.

pip install 01OS
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 publically:

We are currently using localtunnel (https://github.com/localtunnel/localtunnel) to handle the creation of public tunnel endpoints.

Note: You will need to install Node and localtunnel before exposing the service will work correctly: npm install -g localtunnel

01 --server --expose # This will print a URL that a client can point to.

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 # Expose a local server