summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorHammad Shami <[email protected]>2025-12-10 14:23:52 -0800
committerGitHub <[email protected]>2025-12-10 16:23:52 -0600
commit72eb004057a08283f734c7543c08f399f8ba881b (patch)
treedcf443d153c46d1171a1ff248b2fcfce50eb9978
parente46080aa8c34ef3132d76b412cc6e750a2f16b32 (diff)
downloadopencode-72eb004057a08283f734c7543c08f399f8ba881b.tar.gz
opencode-72eb004057a08283f734c7543c08f399f8ba881b.zip
feat: add helicone docs + helicone session tracking (#5265)
-rw-r--r--packages/web/src/content/docs/ecosystem.mdx1
-rw-r--r--packages/web/src/content/docs/providers.mdx113
2 files changed, 114 insertions, 0 deletions
diff --git a/packages/web/src/content/docs/ecosystem.mdx b/packages/web/src/content/docs/ecosystem.mdx
index 845ac6333..77584f1a5 100644
--- a/packages/web/src/content/docs/ecosystem.mdx
+++ b/packages/web/src/content/docs/ecosystem.mdx
@@ -17,6 +17,7 @@ You can also check out [awesome-opencode](https://github.com/awesome-opencode/aw
| Name | Description |
| ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
+| [opencode-helicone-session](https://github.com/H2Shami/opencode-helicone-session) | Automatically inject Helicone session headers for request grouping |
| [opencode-skills](https://github.com/malhashemi/opencode-skills) | Manage and organize OpenCode skills and capabilities |
| [opencode-type-inject](https://github.com/nick-vi/opencode-type-inject) | Auto-inject TypeScript/Svelte types into file reads with lookup tools |
| [opencode-openai-codex-auth](https://github.com/numman-ali/opencode-openai-codex-auth) | Use your ChatGPT Plus/Pro subscription instead of API credits |
diff --git a/packages/web/src/content/docs/providers.mdx b/packages/web/src/content/docs/providers.mdx
index 8405966f7..5f9b040d4 100644
--- a/packages/web/src/content/docs/providers.mdx
+++ b/packages/web/src/content/docs/providers.mdx
@@ -568,6 +568,119 @@ The `global` region improves availability and reduces errors at no extra cost. U
---
+### Helicone
+
+[Helicone](https://helicone.ai) is an LLM observability platform that provides logging, monitoring, and analytics for your AI applications. The Helicone AI Gateway routes your requests to the appropriate provider automatically based on the model.
+
+1. Head over to [Helicone](https://helicone.ai), create an account, and generate an API key from your dashboard.
+
+2. Run the `/connect` command and search for **Helicone**.
+
+ ```txt
+ /connect
+ ```
+
+3. Enter your Helicone API key.
+
+ ```txt
+ ┌ API key
+ │
+ │
+ └ enter
+ ```
+
+4. Run the `/models` command to select a model.
+
+ ```txt
+ /models
+ ```
+
+For more providers and advanced features like caching and rate limiting, check the [Helicone documentation](https://docs.helicone.ai).
+
+#### Optional Configs
+
+In the event you see a feature or model from Helicone that isn't configured automatically through opencode, you can always configure it yourself.
+
+Here's [Helicone's Model Directory](https://helicone.ai/models), you'll need this to grab the IDs of the models you want to add.
+
+```jsonc title="~/.config/opencode/opencode.jsonc"
+{
+ "$schema": "https://opencode.ai/config.json",
+ "provider": {
+ "helicone": {
+ "npm": "@ai-sdk/openai-compatible",
+ "name": "Helicone",
+ "options": {
+ "baseURL": "https://ai-gateway.helicone.ai",
+ },
+ "models": {
+ "gpt-4o": {
+ // Model ID (from Helicone's model directory page)
+ "name": "GPT-4o", // Your own custom name for the model
+ },
+ "claude-sonnet-4-20250514": {
+ "name": "Claude Sonnet 4",
+ },
+ },
+ },
+ },
+}
+```
+
+#### Custom Headers
+
+Helicone supports custom headers for features like caching, user tracking, and session management. Add them to your provider config using `options.headers`:
+
+```jsonc title="~/.config/opencode/opencode.jsonc"
+{
+ "$schema": "https://opencode.ai/config.json",
+ "provider": {
+ "helicone": {
+ "npm": "@ai-sdk/openai-compatible",
+ "name": "Helicone",
+ "options": {
+ "baseURL": "https://ai-gateway.helicone.ai",
+ "headers": {
+ "Helicone-Cache-Enabled": "true",
+ "Helicone-User-Id": "opencode",
+ },
+ },
+ },
+ },
+}
+```
+
+##### Session tracking
+
+Helicone's [Sessions](https://docs.helicone.ai/features/sessions) feature lets you group related LLM requests together. Use the [opencode-helicone-session](https://github.com/H2Shami/opencode-helicone-session) plugin to automatically log each OpenCode conversation as a session in Helicone.
+
+```bash
+npm install -g opencode-helicone-session
+```
+
+Add it to your config.
+
+```json title="opencode.json"
+{
+ "plugin": ["opencode-helicone-session"]
+}
+```
+
+The plugin injects `Helicone-Session-Id` and `Helicone-Session-Name` headers into your requests. In Helicone's Sessions page, you'll see each OpenCode conversation listed as a separate session.
+
+##### Common Helicone headers
+
+| Header | Description |
+| -------------------------- | ------------------------------------------------------------- |
+| `Helicone-Cache-Enabled` | Enable response caching (`true`/`false`) |
+| `Helicone-User-Id` | Track metrics by user |
+| `Helicone-Property-[Name]` | Add custom properties (e.g., `Helicone-Property-Environment`) |
+| `Helicone-Prompt-Id` | Associate requests with prompt versions |
+
+See the [Helicone Header Directory](https://docs.helicone.ai/helicone-headers/header-directory) for all available headers.
+
+---
+
### llama.cpp
You can configure opencode to use local models through [llama.cpp's](https://github.com/ggml-org/llama.cpp) llama-server utility