You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
56 lines
1.1 KiB
56 lines
1.1 KiB
---
|
|
title: "Software Guide"
|
|
sidebarTitle: "Software"
|
|
description: "Get 01OS up and running"
|
|
---
|
|
|
|
## Install dependencies
|
|
|
|
```bash
|
|
# MacOS
|
|
brew install portaudio ffmpeg
|
|
|
|
# Ubuntu
|
|
sudo apt-get install portaudio19-dev ffmpeg
|
|
```
|
|
|
|
## Setup for usage
|
|
|
|
```bash
|
|
pip install 01OS
|
|
```
|
|
|
|
**Run the 01 end-to-end:**
|
|
|
|
```bash
|
|
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:**
|
|
|
|
```bash
|
|
01 --server --expose # This will print a URL that a client can point to.
|
|
```
|
|
|
|
**Run a specific client:**
|
|
|
|
```bash
|
|
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](https://github.com/ggerganov/whisper.cpp) STT and [Piper](https://github.com/rhasspy/piper) TTS models.
|
|
|
|
```bash
|
|
01 --local # Local client and server
|
|
01 --local --server --expose # Expose a local server
|
|
```
|
|
|
|
**Configuration:**
|
|
|
|
Copy the `01OS/.env.example` file to `01OS/.env` then configure the environment variables within the file.
|