diff options
| author | adamdottv <[email protected]> | 2025-07-09 10:12:28 -0500 |
|---|---|---|
| committer | adamdottv <[email protected]> | 2025-07-09 10:12:36 -0500 |
| commit | 8e9e3832198b9a575bdb7bb9f23eb45cf73ed199 (patch) | |
| tree | e4b7a3522e043267955de27aad7466d432445593 /packages/web/src | |
| parent | f383008cc13c755807fc268030dadde6c29fa29a (diff) | |
| download | opencode-8e9e3832198b9a575bdb7bb9f23eb45cf73ed199.tar.gz opencode-8e9e3832198b9a575bdb7bb9f23eb45cf73ed199.zip | |
chore: troubleshooting docs
Diffstat (limited to 'packages/web/src')
| -rw-r--r-- | packages/web/src/content/docs/docs/troubleshooting.mdx | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/packages/web/src/content/docs/docs/troubleshooting.mdx b/packages/web/src/content/docs/docs/troubleshooting.mdx new file mode 100644 index 000000000..1640d6343 --- /dev/null +++ b/packages/web/src/content/docs/docs/troubleshooting.mdx @@ -0,0 +1,74 @@ +--- +title: Troubleshooting +description: Common issues and how to resolve them. +--- + +## Logs + +opencode writes detailed logs that can help diagnose issues. Log files are stored in: + +- **macOS/Linux**: `~/.local/share/opencode/log/` +- **Windows**: `%APPDATA%\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 configure the log level in your [config file](/docs/config#logging) to get more detailed debug information. + +--- + +## Storage + +opencode stores session data and other application data on disk at: + +- **macOS/Linux**: `~/.local/share/opencode/` +- **Windows**: `%APPDATA%\opencode\` + +This directory contains: + +- `auth.json` - Authentication data (e.g., API keys, OAuth tokens) +- `log/` - Application logs +- `project/` - Project-specific data (e.g., session and message data) + +--- + +## Getting help + +If you're experiencing issues with opencode: + +### Report issues on GitHub + +The best way to report bugs or request features is through our GitHub repository: + +[**github.com/sst/opencode/issues**](https://github.com/sst/opencode/issues) + +Before creating a new issue, please search existing issues to see if your problem has already been reported. + +### Join our Discord + +For real-time help and community discussion, join our Discord server: + +[**opencode.ai/discord**](https://opencode.ai/discord) + +Our community and team are happy to help with questions and troubleshooting. + +--- + +## Common issues + +### 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 `opencode auth login <provider>` +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 |
