Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/code-execution/computer-api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Computer API
---

Coming soon...
5 changes: 5 additions & 0 deletions docs/code-execution/custom-languages.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Custom Languages
---

Coming soon...
5 changes: 5 additions & 0 deletions docs/code-execution/settings.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Settings
---

Coming soon...
5 changes: 5 additions & 0 deletions docs/code-execution/usage.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Usage
---

Coming soon...
11 changes: 11 additions & 0 deletions docs/guides/advanced-terminal-usage.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Advanced Terminal Usage
---

Magic commands can be used to control the interpreter's behavior in interactive mode:

- `%verbose [true/false]`: Toggle verbose mode
- `%reset`: Reset the current session
- `%undo`: Remove the last message and its response
- `%save_message [path]`: Save messages to a JSON file
- `%load_message [path]`: Load messages from a JSON file
150 changes: 150 additions & 0 deletions docs/guides/basic-usage.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
---
title: Basic Usage
---


<CardGroup>

<Card
title="Interactive demo"
icon="gamepad-modern"
iconType="solid"
href="https://colab.research.google.com/drive/1WKmRXZgsErej2xUriKzxrEAXdxMSgWbb?usp=sharing"
>
Try Open Interpreter without installing anything on your computer
</Card>

<Card
title="Example voice interface"
icon="circle"
iconType="solid"
href="https://colab.research.google.com/drive/1NojYGHDgxH6Y1G1oxThEBBb2AtyODBIK"
>
An example implementation of Open Interpreter's streaming capabilities
</Card>

</CardGroup>

---

### Interactive Chat

To start an interactive chat in your terminal, either run `interpreter` from the command line:

```shell
interpreter
```

Or `interpreter.chat()` from a .py file:

```python
interpreter.chat()
```

---

### Programmatic Chat

For more precise control, you can pass messages directly to `.chat(message)` in Python:

```python
interpreter.chat("Add subtitles to all videos in /videos.")

# ... Displays output in your terminal, completes task ...

interpreter.chat("These look great but can you make the subtitles bigger?")

# ...
```

---

### Start a New Chat

In your terminal, Open Interpreter behaves like ChatGPT and will not remember previous conversations. Simply run `interpreter` to start a new chat:

```shell
interpreter
```

In Python, Open Interpreter remembers conversation history. If you want to start fresh, you can reset it:

```python
interpreter.messages = []
```

---

### Save and Restore Chats

In your terminal, Open Interpreter will save previous conversations to `<your application directory>/Open Interpreter/conversations/`.

You can resume any of them by running `--conversations`. Use your arrow keys to select one , then press `ENTER` to resume it.

```shell
interpreter --conversations
```

In Python, `interpreter.chat()` returns a List of messages, which can be used to resume a conversation with `interpreter.messages = messages`:

```python
# Save messages to 'messages'
messages = interpreter.chat("My name is Killian.")

# Reset interpreter ("Killian" will be forgotten)
interpreter.messages = []

# Resume chat from 'messages' ("Killian" will be remembered)
interpreter.messages = messages
```

---

### Configure Default Settings

We save default settings to a configuration file which can be edited by running the following command:

```shell
interpreter --config
```

You can use this to set your default language model, system message (custom instructions), max budget, etc.

<Info>**Note:** The Python library will also inherit settings from this config file, but you can only change it by running `interpreter --config` or navigating to `<your application directory>/Open Interpreter/config.yaml` and editing it manually.</Info>

---

### Customize System Message

In your terminal, modify the system message by [editing your configuration file as described here](#configure-default-settings).

In Python, you can inspect and configure Open Interpreter's system message to extend its functionality, modify permissions, or give it more context.

```python
interpreter.system_message += """
Run shell commands with -y so the user doesn't have to confirm them.
"""
print(interpreter.system_message)
```

---

### Change your Language Model

Open Interpreter uses [LiteLLM](https://docs.litellm.ai/docs/providers/) to connect to language models.

You can change the model by setting the model parameter:

```shell
interpreter --model gpt-3.5-turbo
interpreter --model claude-2
interpreter --model command-nightly
```

In Python, set the model on the object:

```python
interpreter.llm.model = "gpt-3.5-turbo"
```

[Find the appropriate "model" string for your language model here.](https://docs.litellm.ai/docs/providers/)
68 changes: 68 additions & 0 deletions docs/guides/demos.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
title: Demos
---

### Vision Mode

#### Recreating a Tailwind Component

Creating a dropdown menu in Tailwind from a single screenshot:

https://twitter.com/hellokillian/status/1723106008061587651

#### Recreating the ChatGPT interface using GPT-4V:

https://twitter.com/chilang/status/1724577200135897255

### OS Mode

#### Playing Music

Open Interpreter playing some Lofi using OS mode:

<iframe
width="560"
height="315"
src="https://www.youtube.com/watch?v=CEs51hGWuGU&ab_channel=MikeBird"
title="3 Ways to Use Open Interpreter FOR FREE, locally and with Open Source Software
"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowFullScreen
></iframe>

#### Open Interpreter Chatting with Open Interpreter

OS mode creating and chatting with a local instance of Open Interpreter:

https://twitter.com/FieroTy/status/1746639975234560101

#### Controlling an Arduino

Reading temperature and humidity from an Arudino:

https://twitter.com/vindiww/status/1744252926321942552

#### Music Creation

OS mode using Logic Pro X to record a piano song and play it back:

https://twitter.com/FieroTy/status/1744203268451111035

#### Generating images in Everart.ai

Open Interpreter descibing pictures it wants to make, then creating them using OS mode:

https://twitter.com/skirano/status/1747670816437735836

#### Open Interpreter Conversing With ChatGPT

OS mode has a conversation with ChatGPT and even asks it "What do you think about human/AI interaction?"

https://twitter.com/skirano/status/1747772471770583190

#### Sending an Email with Gmail

OS mode launches Safari, composes an email, and sends it:

https://twitter.com/FieroTy/status/1743437525207928920
5 changes: 5 additions & 0 deletions docs/guides/multiple-instances.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Multiple Instances
---

Coming soon...
44 changes: 44 additions & 0 deletions docs/guides/running-locally.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: Running Locally
---

Check out this awesome video by Mike Bird on how to run Open Interpreter locally! He goes over three different methods for setting up a local language model to run with Open Interpreter.

<iframe
width="560"
height="315"
src="https://www.youtube.com/watch?v=CEs51hGWuGU&ab_channel=MikeBird"
title="3 Ways to Use Open Interpreter FOR FREE, locally and with Open Source Software
"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowFullScreen
></iframe>

## How to use Open Interpreter locally

### Ollama

1. Download Ollama - https://ollama.ai/download
2. `ollama run dolphin-mixtral:8x7b-v2.6`
3. `interpreter --model ollama/dolphin-mixtral:8x7b-v2.6`

# Jan.ai

1. Download Jan - [Jan.ai](http://jan.ai/)
2. Download model from Hub
3. Enable API server
1. Settings
2. Advanced
3. Enable API server
4. Select Model to use
5. `interpreter --api_base http://localhost:1337/v1 --model mixtral-8x7b-instruct`

# llamafile

1. Download or make a llamafile - https://github.com/Mozilla-Ocho/llamafile
2. `chmod +x mixtral-8x7b-instruct-v0.1.Q5_K_M.llamafile`
3. `./mixtral-8x7b-instruct-v0.1.Q5_K_M.llamafile`
4. `interpreter --api_base https://localhost:8080/v1`

Make sure that Xcode is installed for Apple Silicon
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ title: Custom Endpoint
Simply set `api_base` to any OpenAI compatible server:

<CodeGroup>

```bash Terminal
interpreter --api_base <custom_endpoint>
```
Expand All @@ -17,4 +16,4 @@ interpreter.llm.api_base = "<custom_endpoint>"
interpreter.chat()
```

</CodeGroup>
</CodeGroup>
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Jan.ai is an open-source platform for running local language models on your comp

To run Open Interpreter with Jan.ai, follow these steps:

1. Install the Jan.ai Desktop Application on your computer. At the time of writing, you will need to download a nightly build, as the standard application does not come with a local server. You can find instructions for installing a nightly build [here](https://jan.ai/install/nightly/).
1. [Install](https://jan.ai/) the Jan.ai Desktop Application on your computer.

2. Once installed, you will need to install a language model. Click the 'Hub' icon on the left sidebar (the four squares icon). Click the 'Download' button next to the model you would like to install, and wait for it to finish installing before continuing.

Expand Down
4 changes: 4 additions & 0 deletions docs/language-models/settings.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Settings
---
Coming soon...
5 changes: 5 additions & 0 deletions docs/language-models/usage.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Usage
---

Coming soon...
Loading