- Full Obsidian vault content - Host configs (ice, grizzley, ubuntu, proxmox, truenas, panda, hyte) - Media stack documentation - Traefik HA setup - Automation scripts - Bachelor party planning
273 lines
9.0 KiB
Markdown
273 lines
9.0 KiB
Markdown
---
|
||
type: agent-doc
|
||
agent: OpenCode
|
||
source: https://opencode.ai/docs/troubleshooting/
|
||
scraped: 2026-04-28T21:02:13.425323+00:00
|
||
content_hash: 424a7eef
|
||
---
|
||
# Troubleshooting
|
||
|
||
Common issues and how to resolve them.
|
||
|
||
To debug issues with OpenCode, start by checking the logs and local data it stores on disk.
|
||
|
||
---
|
||
|
||
## Logs
|
||
|
||
Log files are written to:
|
||
|
||
- macOS/Linux: ~/.local/share/opencode/log/
|
||
- Windows: Press WIN+R and paste %USERPROFILE%\.local\share\opencode\log
|
||
|
||
Log files are named with timestamps (e.g., 2025-01-09T123456.log) and the most recent 10 log files are kept.
|
||
|
||
You can set the log level with the --log-level command-line option to get more detailed debug information. For example, opencode --log-level DEBUG.
|
||
|
||
---
|
||
|
||
## Storage
|
||
|
||
opencode stores session data and other application data on disk at:
|
||
|
||
- macOS/Linux: ~/.local/share/opencode/
|
||
- Windows: Press WIN+R and paste %USERPROFILE%\.local\share\opencode
|
||
|
||
This directory contains:
|
||
|
||
- auth.json - Authentication data like API keys, OAuth tokens
|
||
- log/ - Application logs
|
||
- project/ - Project-specific data like session and message data If the project is within a Git repo, it is stored in ./<project-slug>/storage/ If it is not a Git repo, it is stored in ./global/storage/
|
||
- If the project is within a Git repo, it is stored in ./<project-slug>/storage/
|
||
- If it is not a Git repo, it is stored in ./global/storage/
|
||
|
||
---
|
||
|
||
## Desktop app
|
||
|
||
OpenCode Desktop runs a local OpenCode server (the opencode-cli sidecar) in the background. Most issues are caused by a misbehaving plugin, a corrupted cache, or a bad server setting.
|
||
|
||
### Quick checks
|
||
|
||
- Fully quit and relaunch the app.
|
||
- If the app shows an error screen, click Restart and copy the error details.
|
||
- macOS only: OpenCode menu -> Reload Webview (helps if the UI is blank/frozen).
|
||
|
||
---
|
||
|
||
### Disable plugins
|
||
|
||
If the desktop app is crashing on launch, hanging, or behaving strangely, start by disabling plugins.
|
||
|
||
#### Check the global config
|
||
|
||
Open your global config file and look for a plugin key.
|
||
|
||
- macOS/Linux: ~/.config/opencode/opencode.jsonc (or ~/.config/opencode/opencode.json)
|
||
- macOS/Linux (older installs): ~/.local/share/opencode/opencode.jsonc
|
||
- Windows: Press WIN+R and paste %USERPROFILE%\.config\opencode\opencode.jsonc
|
||
|
||
If you have plugins configured, temporarily disable them by removing the key or setting it to an empty array:
|
||
|
||
```
|
||
{ "$schema": "https://opencode.ai/config.json", "plugin": [],}
|
||
```
|
||
|
||
#### Check plugin directories
|
||
|
||
OpenCode can also load local plugins from disk. Temporarily move these out of the way (or rename the folder) and restart the desktop app:
|
||
|
||
- Global plugins macOS/Linux: ~/.config/opencode/plugins/ Windows: Press WIN+R and paste %USERPROFILE%\.config\opencode\plugins
|
||
- macOS/Linux: ~/.config/opencode/plugins/
|
||
- Windows: Press WIN+R and paste %USERPROFILE%\.config\opencode\plugins
|
||
|
||
- Project plugins (only if you use per-project config) <your-project>/.opencode/plugins/
|
||
- <your-project>/.opencode/plugins/
|
||
|
||
If the app starts working again, re-enable plugins one at a time to find which one is causing the issue.
|
||
|
||
---
|
||
|
||
### Clear the cache
|
||
|
||
If disabling plugins doesnât help (or a plugin install is stuck), clear the cache so OpenCode can rebuild it.
|
||
|
||
1. Quit OpenCode Desktop completely.
|
||
2. Delete the cache directory:
|
||
|
||
- macOS: Finder -> Cmd+Shift+G -> paste ~/.cache/opencode
|
||
- Linux: delete ~/.cache/opencode (or run rm -rf ~/.cache/opencode)
|
||
- Windows: Press WIN+R and paste %USERPROFILE%\.cache\opencode
|
||
|
||
1. Restart OpenCode Desktop.
|
||
|
||
---
|
||
|
||
### Fix server connection issues
|
||
|
||
OpenCode Desktop can either start its own local server (default) or connect to a server URL you configured.
|
||
|
||
If you see a âConnection Failedâ dialog (or the app never gets past the splash screen), check for a custom server URL.
|
||
|
||
#### Clear the desktop default server URL
|
||
|
||
From the Home screen, click the server name (with the status dot) to open the Server picker. In the Default server section, click Clear.
|
||
|
||
#### Remove server.port / server.hostname from your config
|
||
|
||
If your opencode.json(c) contains a server section, temporarily remove it and restart the desktop app.
|
||
|
||
#### Check environment variables
|
||
|
||
If you have OPENCODE_PORT set in your environment, the desktop app will try to use that port for the local server.
|
||
|
||
- Unset OPENCODE_PORT (or pick a free port) and restart.
|
||
|
||
---
|
||
|
||
### Linux: Wayland / X11 issues
|
||
|
||
On Linux, some Wayland setups can cause blank windows or compositor errors.
|
||
|
||
- If youâre on Wayland and the app is blank/crashing, try launching with OC_ALLOW_WAYLAND=1.
|
||
- If that makes things worse, remove it and try launching under an X11 session instead.
|
||
|
||
---
|
||
|
||
### Windows: WebView2 runtime
|
||
|
||
On Windows, OpenCode Desktop requires the Microsoft Edge WebView2 Runtime. If the app opens to a blank window or wonât start, install/update WebView2 and try again.
|
||
|
||
---
|
||
|
||
### Windows: General performance issues
|
||
|
||
If youâre experiencing slow performance, file access issues, or terminal problems on Windows, try using WSL (Windows Subsystem for Linux). WSL provides a Linux environment that works more seamlessly with OpenCodeâs features.
|
||
|
||
---
|
||
|
||
### Notifications not showing
|
||
|
||
OpenCode Desktop only shows system notifications when:
|
||
|
||
- notifications are enabled for OpenCode in your OS settings, and
|
||
- the app window is not focused.
|
||
|
||
---
|
||
|
||
### Reset desktop app storage (last resort)
|
||
|
||
If the app wonât start and you canât clear settings from inside the UI, reset the desktop appâs saved state.
|
||
|
||
1. Quit OpenCode Desktop.
|
||
2. Find and delete these files (they live in the OpenCode Desktop app data directory):
|
||
|
||
- opencode.settings.dat (desktop default server URL)
|
||
- opencode.global.dat and opencode.workspace.*.dat (UI state like recent servers/projects)
|
||
|
||
To find the directory quickly:
|
||
|
||
- macOS: Finder -> Cmd+Shift+G -> ~/Library/Application Support (then search for the filenames above)
|
||
- Linux: search under ~/.local/share for the filenames above
|
||
- Windows: Press WIN+R -> %APPDATA% (then search for the filenames above)
|
||
|
||
---
|
||
|
||
## Getting help
|
||
|
||
If youâre experiencing issues with OpenCode:
|
||
|
||
1. Report issues on GitHub The best way to report bugs or request features is through our GitHub repository: github.com/anomalyco/opencode/issues Before creating a new issue, search existing issues to see if your problem has already been reported.
|
||
2. Join our Discord For real-time help and community discussion, join our Discord server: opencode.ai/discord
|
||
|
||
---
|
||
|
||
## Common issues
|
||
|
||
Here are some common issues and how to resolve them.
|
||
|
||
---
|
||
|
||
### OpenCode wonât start
|
||
|
||
1. Check the logs for error messages
|
||
2. Try running with --print-logs to see output in the terminal
|
||
3. Ensure you have the latest version with opencode upgrade
|
||
|
||
---
|
||
|
||
### Authentication issues
|
||
|
||
1. Try re-authenticating with the /connect command in the TUI
|
||
2. Check that your API keys are valid
|
||
3. Ensure your network allows connections to the providerâs API
|
||
|
||
---
|
||
|
||
### Model not available
|
||
|
||
1. Check that youâve authenticated with the provider
|
||
2. Verify the model name in your config is correct
|
||
3. Some models may require specific access or subscriptions
|
||
|
||
If you encounter ProviderModelNotFoundError you are most likely incorrectly referencing a model somewhere. Models should be referenced like so: <providerId>/<modelId>
|
||
|
||
Examples:
|
||
|
||
- openai/gpt-4.1
|
||
- openrouter/google/gemini-2.5-flash
|
||
- opencode/kimi-k2
|
||
|
||
To figure out what models you have access to, run opencode models
|
||
|
||
---
|
||
|
||
### ProviderInitError
|
||
|
||
If you encounter a ProviderInitError, you likely have an invalid or corrupted configuration.
|
||
|
||
To resolve this:
|
||
|
||
1. First, verify your provider is set up correctly by following the providers guide
|
||
2. If the issue persists, try clearing your stored configuration: Terminal windowrm -rf ~/.local/share/opencode On Windows, press WIN+R and delete: %USERPROFILE%\.local\share\opencode
|
||
3. Re-authenticate with your provider using the /connect command in the TUI.
|
||
|
||
---
|
||
|
||
### AI_APICallError and provider package issues
|
||
|
||
If you encounter API call errors, this may be due to outdated provider packages. opencode dynamically installs provider packages (OpenAI, Anthropic, Google, etc.) as needed and caches them locally.
|
||
|
||
To resolve provider package issues:
|
||
|
||
1. Clear the provider package cache: Terminal windowrm -rf ~/.cache/opencode On Windows, press WIN+R and delete: %USERPROFILE%\.cache\opencode
|
||
2. Restart opencode to reinstall the latest provider packages
|
||
|
||
This will force opencode to download the most recent versions of provider packages, which often resolves compatibility issues with model parameters and API changes.
|
||
|
||
---
|
||
|
||
### Copy/paste not working on Linux
|
||
|
||
Linux users need to have one of the following clipboard utilities installed for copy/paste functionality to work:
|
||
|
||
For X11 systems:
|
||
|
||
```
|
||
apt install -y xclip# orapt install -y xsel
|
||
```
|
||
|
||
For Wayland systems:
|
||
|
||
```
|
||
apt install -y wl-clipboard
|
||
```
|
||
|
||
For headless environments:
|
||
|
||
```
|
||
apt install -y xvfb# and run:Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &export DISPLAY=:99.0
|
||
```
|
||
|
||
opencode will detect if youâre using Wayland and prefer wl-clipboard, otherwise it will try to find clipboard tools in order of: xclip and xsel.
|