Skip to content

Latest commit

 

History

History
130 lines (93 loc) · 4.12 KB

open-interpreter.mdx

File metadata and controls

130 lines (93 loc) · 4.12 KB
title description sidebar_label sidebar_position
Use CodeGate with Open Interpreter
Configure Open Interpreter to use CodeGate
Open Interpreter
70

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Open Interpreter lets LLMs run code locally through a ChatGPT-like interface in your terminal.

CodeGate works with OpenAI and compatible APIs through Open Interpreter.

You can also configure CodeGate muxing to select your provider and model using workspaces.

:::note

This guide assumes you have already installed Open Interpreter using their installation instructions.

:::

Configure Open Interpreter to use CodeGate

To configure Open Interpreter to send requests through CodeGate, run interpreter with the API base setting set to CodeGate's local API port, http://localhost:8989/<provider>.

First, configure your [provider(s)](../features/muxing.md#add-a-provider) and select a model for each of your [workspace(s)](../features/workspaces.mdx#manage-workspaces) in the CodeGate dashboard.

When you run interpreter, the API key parameter is required but the value is not used. The --model setting must start with openai/ but the actual model is determined by your CodeGate workspace.

```bash interpreter --api_base http://localhost:8989/v1/mux --api_key fake-value-not-used --model openai/fake-value-not-used ``` 
</TabItem>
<TabItem value="dev" label="v1.0 dev branch">
  If you are running Open Interpreter's v1.0
  [development branch](https://github.com/OpenInterpreter/open-interpreter/tree/development):

  ```bash
  interpreter --api-base http://localhost:8989/v1/mux --api-key fake-value-not-used --model openai/fake-value-not-used
  ```

</TabItem>
You need an [OpenAI API](https://openai.com/api/) account to use this provider. To use a different OpenAI-compatible endpoint, set the `CODEGATE_OPENAI_URL` [configuration parameter](../how-to/configure.md) when you launch CodeGate. ```bash interpreter --api_base http://localhost:8989/openai --api_key YOUR_API_KEY --model MODEL_NAME ``` 
</TabItem>
<TabItem value="dev" label="v1.0 dev branch">
  If you are running Open Interpreter's v1.0
  [development branch](https://github.com/OpenInterpreter/open-interpreter/tree/development):

  ```bash
  interpreter --api-base http://localhost:8989/openai --api-key YOUR_API_KEY --model MODEL_NAME
  ```

</TabItem>

Replace YOUR_API_KEY with your OpenAI API key, and MODEL_NAME with your desired model, like openai/gpt-4o-mini.

:::info

The --model parameter value must start with openai/ for CodeGate to properly handle the request.

:::

Verify configuration

To verify that you've successfully connected Open Interpreter to CodeGate, type codegate version into the Open Interpreter chat. You should receive a response like "CodeGate version 0.1.16".

Next steps

Learn more about CodeGate's features and explore the dashboard.

Remove CodeGate

If you decide to stop using CodeGate, follow these steps to remove it and revert your environment.

  1. Quit Open Interpreter (Ctrl+C) and re-run it without the API base parameter.

  2. Stop and remove the CodeGate container:

    docker rm -f codegate

  3. If you launched CodeGate with a persistent volume, delete it to remove the CodeGate database and other files:

    docker volume rm codegate_volume