mirror of
https://github.com/imartinez/privateGPT.git
synced 2026-07-17 01:48:03 +00:00
8a5c36725d
* chore: add docs redirects
(cherry picked from commit 29fec7af0e)
* chore: fix links on doc
(cherry picked from commit ba56846b36a0e985e5efe5b38b09c1dfdf3e9acc)
(cherry picked from commit 2f86726aab656f12e809aa2bc83f67d8d08c83d8)
* fix: use current host instead hardcoded
(cherry picked from commit e32cac5afb13d49fba25101bd86afb1694044434)
* docs: fix links of doc
(cherry picked from commit 165f4c1a2abf65ba70ba2ba783ff644badfdf4a2)
* Potential fix for pull request finding
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
* docs: update index link
---------
Co-authored-by: Alfonso Lozana <alfonsolozana@gmail.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
91 lines
2.4 KiB
Plaintext
91 lines
2.4 KiB
Plaintext
---
|
|
title: "OpenCode"
|
|
description: "Point OpenCode at your private-gpt server for fully local AI coding."
|
|
---
|
|
|
|
[OpenCode](https://opencode.ai) is an open-source AI coding agent with terminal, IDE, and desktop interfaces. It supports custom OpenAI-compatible providers via the `@ai-sdk/openai-compatible` package, so it works with `private-gpt` out of the box.
|
|
|
|
## Compatibility
|
|
|
|
| Feature | Status | Notes |
|
|
|---|:---:|---|
|
|
| Chat & streaming | ✅ | |
|
|
| Tool use / function calling | ✅ | Model-dependent |
|
|
| File tools (read, write, edit) | ✅ | Managed by OpenCode |
|
|
| MCP servers | ✅ | Configured in OpenCode |
|
|
| Multi-session agents | ✅ | |
|
|
| Images | ❌ | Not supported |
|
|
|
|
---
|
|
|
|
## Prerequisites
|
|
|
|
- OpenCode installed — see [opencode.ai](https://opencode.ai)
|
|
- `private-gpt` server running (see [serve](/configuration/cli#serve))
|
|
|
|
---
|
|
|
|
## Run
|
|
|
|
`private-gpt run` generates a config file at `~/.config/opencode/private-gpt.json`, sets `OPENCODE_CONFIG` to point at it, and launches OpenCode:
|
|
|
|
```bash
|
|
private-gpt run opencode
|
|
```
|
|
|
|
The server is started automatically if it is not already running. Pass `--no-server` to skip that check when the server is managed externally.
|
|
|
|
**With a specific model:**
|
|
|
|
```bash
|
|
private-gpt run opencode --model my-model
|
|
```
|
|
|
|
On first launch, press `Ctrl+P` → **Switch Model** → select the model under **PrivateGPT**.
|
|
|
|
---
|
|
|
|
## Manual setup
|
|
|
|
If you prefer to manage the configuration yourself:
|
|
|
|
**1. Create the config file**
|
|
|
|
Create `~/.config/opencode/private-gpt.json` (a separate file to avoid overriding your default OpenCode config):
|
|
|
|
```json
|
|
{
|
|
"$schema": "https://opencode.ai/config.json",
|
|
"provider": {
|
|
"private-gpt": {
|
|
"npm": "@ai-sdk/openai-compatible",
|
|
"name": "PrivateGPT",
|
|
"options": {
|
|
"baseURL": "http://localhost:8080/v1",
|
|
"apiKey": "secret-key"
|
|
},
|
|
"models": {
|
|
"default": {
|
|
"name": "PrivateGPT - default",
|
|
"limit": {
|
|
"context": 8096,
|
|
"output": 1024
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
Replace `secret-key` with the value of `server.auth.secret` from your `private-gpt` settings. If auth is disabled, any non-empty string works.
|
|
|
|
**2. Launch with the custom config**
|
|
|
|
```bash
|
|
export OPENCODE_CONFIG=~/.config/opencode/private-gpt.json
|
|
opencode
|
|
```
|
|
|
|
On first launch, press `Ctrl+P` → **Switch Model** → select the model under **PrivateGPT**.
|