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.
01/README.md

84 lines
3.1 KiB

10 months ago
<h1 align="center"></h1>
<p align="center">
10 months ago
<a href="https://discord.gg/Hvz9Axh84z"><img alt="Discord" src="https://img.shields.io/discord/1146610656779440188?logo=discord&style=social&logoColor=black"/></a>
10 months ago
<br>
<br>
5 months ago
<strong>The #1 open-source voice interface.</strong><br>
<br><a href="https://changes.openinterpreter.com">Get Updates</a> | <a href="https://01.openinterpreter.com/">Documentation</a><br>
10 months ago
</p>
3 months ago
<br>
> [!NOTE]
> You can talk to your 01 using OpenAI's [Realtime API](https://platform.openai.com/docs/guides/realtime) (Advanced Voice Mode) via the `--multimodel` flag, e.g:
> ```shell
> poetry run 01 --server livekit --qr --expose --multimodal
> ```
4 months ago
<br></br>
4 months ago
![01 Project Banner](https://raw.githubusercontent.com/OpenInterpreter/01/main/docs/assets/banner.png)
10 months ago
4 months ago
<br></br>
The **01** is an open-source platform for intelligent devices, inspired by the *Rabbit R1* and *Star Trek* computer. Powered by [Open Interpreter](https://github.com/OpenInterpreter/open-interpreter), it provides a natural language voice interface for computers.
<br>
10 months ago
9 months ago
> [!IMPORTANT]
4 months ago
> This experimental project is under rapid development and lacks basic safeguards. Until a stable `1.0` release, only run this on devices without sensitive information or access to paid services.
10 months ago
4 months ago
<br>
## Capabilities
5 months ago
- Execute code
- Browse the web
4 months ago
- Manage files
5 months ago
- Control third-party software
5 months ago
4 months ago
## Getting Started
10 months ago
4 months ago
For detailed setup instructions, visit our [installation guide](https://01.openinterpreter.com/setup/installation).
10 months ago
4 months ago
## Server Options
10 months ago
4 months ago
1. **Light Server**: Optimized for low-power devices like ESP32. [Learn more](https://01.openinterpreter.com/server/light)
2. **Livekit Server**: Full-featured for higher processing power devices. [Learn more](https://01.openinterpreter.com/server/livekit)
10 months ago
4 months ago
## Clients
10 months ago
4 months ago
- [Android & iOS App](https://01.openinterpreter.com/client/android-ios)
- [ESP32 Implementation](https://01.openinterpreter.com/client/esp32)
- [Desktop Client](https://01.openinterpreter.com/client/desktop)
10 months ago
4 months ago
## Hardware
10 months ago
4 months ago
Build your own [01 Light device](https://01.openinterpreter.com/hardware/01-light/introduction) or explore other [hardware options](https://01.openinterpreter.com/hardware/introduction).
10 months ago
4 months ago
## Customization
10 months ago
4 months ago
Customize behavior, language model, system message, and more by editing profiles in the `software/source/server/profiles` directory. [Configuration guide](https://01.openinterpreter.com/server/configure)
10 months ago
4 months ago
## Safety Considerations
4 months ago
Understand the [risks](https://01.openinterpreter.com/safety/risks) and implement [safety measures](https://01.openinterpreter.com/safety/measures) when using 01.
10 months ago
4 months ago
## Contributing
4 months ago
We welcome contributions! Check out our [contributing guidelines](CONTRIBUTING.md) and join our [Discord community](https://discord.gg/Hvz9Axh84z).
4 months ago
## Documentation
4 months ago
For comprehensive guides, API references, and troubleshooting, visit our [official documentation](https://01.openinterpreter.com/).
10 months ago
4 months ago
<br></br>
10 months ago
4 months ago
<p align="center">
<a href="https://github.com/OpenInterpreter/01/blob/main/CONTEXT.md">Context</a>
<a href="/ROADMAP.md">Roadmap</a>
</p>
10 months ago
3 months ago
<p align="center"></p>