From acd7dc90bd7051ef5d44a78716b2ac3ec66c13b2 Mon Sep 17 00:00:00 2001 From: "openclaw-docs-sync[bot]" Date: Mon, 6 Apr 2026 18:54:04 +0000 Subject: [PATCH] chore(sync): mirror docs from openclaw/openclaw@1b7e16668e613a8ed01fe8066947e865ea2b7aea --- .openclaw-sync/source.json | 4 +- docs/docs.json | 13 +++++ docs/plugins/architecture.md | 9 ++- docs/plugins/manifest.md | 7 +++ docs/plugins/sdk-channel-plugins.md | 12 +++- docs/providers/arcee.md | 87 +++++++++++++++++++++++++++++ docs/providers/index.md | 1 + 7 files changed, 126 insertions(+), 7 deletions(-) create mode 100644 docs/providers/arcee.md diff --git a/.openclaw-sync/source.json b/.openclaw-sync/source.json index 4063c9833..9ec5282d7 100644 --- a/.openclaw-sync/source.json +++ b/.openclaw-sync/source.json @@ -1,5 +1,5 @@ { "repository": "openclaw/openclaw", - "sha": "f9c721d5bf9fb320ddefde95f0944a5b1f743da6", - "syncedAt": "2026-04-06T18:48:27.098Z" + "sha": "1b7e16668e613a8ed01fe8066947e865ea2b7aea", + "syncedAt": "2026-04-06T18:54:03.751Z" } diff --git a/docs/docs.json b/docs/docs.json index b9947c86e..074164466 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -1250,6 +1250,7 @@ "pages": [ "providers/alibaba", "providers/anthropic", + "providers/arcee", "providers/bedrock", "providers/bedrock-mantle", "providers/chutes", @@ -2617,6 +2618,7 @@ "pages": [ "ja-JP/providers/alibaba", "ja-JP/providers/anthropic", + "ja-JP/providers/arcee", "ja-JP/providers/bedrock", "ja-JP/providers/bedrock-mantle", "ja-JP/providers/chutes", @@ -3369,6 +3371,7 @@ "pages": [ "es/providers/alibaba", "es/providers/anthropic", + "es/providers/arcee", "es/providers/bedrock", "es/providers/bedrock-mantle", "es/providers/chutes", @@ -4121,6 +4124,7 @@ "pages": [ "pt-BR/providers/alibaba", "pt-BR/providers/anthropic", + "pt-BR/providers/arcee", "pt-BR/providers/bedrock", "pt-BR/providers/bedrock-mantle", "pt-BR/providers/chutes", @@ -4873,6 +4877,7 @@ "pages": [ "ko/providers/alibaba", "ko/providers/anthropic", + "ko/providers/arcee", "ko/providers/bedrock", "ko/providers/bedrock-mantle", "ko/providers/chutes", @@ -5625,6 +5630,7 @@ "pages": [ "de/providers/alibaba", "de/providers/anthropic", + "de/providers/arcee", "de/providers/bedrock", "de/providers/bedrock-mantle", "de/providers/chutes", @@ -6377,6 +6383,7 @@ "pages": [ "fr/providers/alibaba", "fr/providers/anthropic", + "fr/providers/arcee", "fr/providers/bedrock", "fr/providers/bedrock-mantle", "fr/providers/chutes", @@ -7129,6 +7136,7 @@ "pages": [ "ar/providers/alibaba", "ar/providers/anthropic", + "ar/providers/arcee", "ar/providers/bedrock", "ar/providers/bedrock-mantle", "ar/providers/chutes", @@ -7881,6 +7889,7 @@ "pages": [ "it/providers/alibaba", "it/providers/anthropic", + "it/providers/arcee", "it/providers/bedrock", "it/providers/bedrock-mantle", "it/providers/chutes", @@ -8633,6 +8642,7 @@ "pages": [ "tr/providers/alibaba", "tr/providers/anthropic", + "tr/providers/arcee", "tr/providers/bedrock", "tr/providers/bedrock-mantle", "tr/providers/chutes", @@ -9385,6 +9395,7 @@ "pages": [ "uk/providers/alibaba", "uk/providers/anthropic", + "uk/providers/arcee", "uk/providers/bedrock", "uk/providers/bedrock-mantle", "uk/providers/chutes", @@ -10137,6 +10148,7 @@ "pages": [ "id/providers/alibaba", "id/providers/anthropic", + "id/providers/arcee", "id/providers/bedrock", "id/providers/bedrock-mantle", "id/providers/chutes", @@ -10889,6 +10901,7 @@ "pages": [ "pl/providers/alibaba", "pl/providers/anthropic", + "pl/providers/arcee", "pl/providers/bedrock", "pl/providers/bedrock-mantle", "pl/providers/chutes", diff --git a/docs/plugins/architecture.md b/docs/plugins/architecture.md index fbac3ec0c..225c36715 100644 --- a/docs/plugins/architecture.md +++ b/docs/plugins/architecture.md @@ -609,8 +609,9 @@ conversation, and it runs after core approval handling finishes. Provider plugins now have two layers: -- manifest metadata: `providerAuthEnvVars` for cheap env-auth lookup before - runtime load, plus `providerAuthChoices` for cheap onboarding/auth-choice +- manifest metadata: `providerAuthEnvVars` for cheap provider env-auth lookup + before runtime load, `channelEnvVars` for cheap channel env/setup lookup + before runtime load, plus `providerAuthChoices` for cheap onboarding/auth-choice labels and CLI flag metadata before runtime load - config-time hooks: `catalog` / legacy `discovery` plus `applyConfigDefaults` - runtime hooks: `normalizeModelId`, `normalizeTransport`, @@ -645,6 +646,10 @@ one-flag auth wiring without loading provider runtime. Keep provider runtime `envVars` for operator-facing hints such as onboarding labels or OAuth client-id/client-secret setup vars. +Use manifest `channelEnvVars` when a channel has env-driven auth or setup that +generic shell-env fallback, config/status checks, or setup prompts should see +without loading channel runtime. + ### Hook order and usage For model/provider plugins, OpenClaw calls hooks in this rough order. diff --git a/docs/plugins/manifest.md b/docs/plugins/manifest.md index 986325277..50aa7c2a2 100644 --- a/docs/plugins/manifest.md +++ b/docs/plugins/manifest.md @@ -93,6 +93,9 @@ Those belong in your plugin code and `package.json`. "providerAuthEnvVars": { "openrouter": ["OPENROUTER_API_KEY"] }, + "channelEnvVars": { + "openrouter-chatops": ["OPENROUTER_CHATOPS_TOKEN"] + }, "providerAuthChoices": [ { "provider": "openrouter", @@ -142,6 +145,7 @@ Those belong in your plugin code and `package.json`. | `modelSupport` | No | `object` | Manifest-owned shorthand model-family metadata used to auto-load the plugin before runtime. | | `cliBackends` | No | `string[]` | CLI inference backend ids owned by this plugin. Used for startup auto-activation from explicit config refs. | | `providerAuthEnvVars` | No | `Record` | Cheap provider-auth env metadata that OpenClaw can inspect without loading plugin code. | +| `channelEnvVars` | No | `Record` | Cheap channel env metadata that OpenClaw can inspect without loading plugin code. Use this for env-driven channel setup or auth surfaces that generic startup/config helpers should see. | | `providerAuthChoices` | No | `object[]` | Cheap auth-choice metadata for onboarding pickers, preferred-provider resolution, and simple CLI flag wiring. | | `contracts` | No | `object` | Static bundled capability snapshot for speech, realtime transcription, realtime voice, media-understanding, image-generation, music-generation, video-generation, web-fetch, web search, and tool ownership. | | `channelConfigs` | No | `Record` | Manifest-owned channel config metadata merged into discovery and validation surfaces before runtime loads. | @@ -436,6 +440,9 @@ See [Configuration reference](/gateway/configuration) for the full `plugins.*` s - `providerAuthEnvVars` is the cheap metadata path for auth probes, env-marker validation, and similar provider-auth surfaces that should not boot plugin runtime just to inspect env names. +- `channelEnvVars` is the cheap metadata path for shell-env fallback, setup + prompts, and similar channel surfaces that should not boot plugin runtime + just to inspect env names. - `providerAuthChoices` is the cheap metadata path for auth-choice pickers, `--auth-choice` resolution, preferred-provider mapping, and simple onboarding CLI flag registration before provider runtime loads. For runtime wizard diff --git a/docs/plugins/sdk-channel-plugins.md b/docs/plugins/sdk-channel-plugins.md index 4474afa24..1bd6d5a7f 100644 --- a/docs/plugins/sdk-channel-plugins.md +++ b/docs/plugins/sdk-channel-plugins.md @@ -108,9 +108,15 @@ For setup specifically: - `openclaw/plugin-sdk/channel-setup` covers the optional-install setup builders plus a few setup-safe primitives: `createOptionalChannelSetupSurface`, `createOptionalChannelSetupAdapter`, - `createOptionalChannelSetupWizard`, `DEFAULT_ACCOUNT_ID`, - `createTopLevelChannelDmPolicy`, `setSetupChannelEnabled`, and - `splitSetupEntries` + +If your channel supports env-driven setup or auth and generic startup/config +flows should know those env names before runtime loads, declare them in the +plugin manifest with `channelEnvVars`. Keep channel runtime `envVars` or local +constants for operator-facing copy only. +`createOptionalChannelSetupWizard`, `DEFAULT_ACCOUNT_ID`, +`createTopLevelChannelDmPolicy`, `setSetupChannelEnabled`, and +`splitSetupEntries` + - use the broader `openclaw/plugin-sdk/setup` seam only when you also need the heavier shared setup/config helpers such as `moveSingleAccountChannelSectionToDefaultAccount(...)` diff --git a/docs/providers/arcee.md b/docs/providers/arcee.md new file mode 100644 index 000000000..a085fa47d --- /dev/null +++ b/docs/providers/arcee.md @@ -0,0 +1,87 @@ +--- +title: "Arcee AI" +summary: "Arcee AI setup (auth + model selection)" +read_when: + - You want to use Arcee AI with OpenClaw + - You need the API key env var or CLI auth choice +--- + +# Arcee AI + +[Arcee AI](https://arcee.ai) provides access to the Trinity family of mixture-of-experts models through an OpenAI-compatible API. All Trinity models are Apache 2.0 licensed. + +Arcee AI models can be accessed directly via the Arcee platform or through [OpenRouter](/providers/openrouter). + +- Provider: `arcee` +- Auth: `ARCEEAI_API_KEY` (direct) or `OPENROUTER_API_KEY` (via OpenRouter) +- API: OpenAI-compatible +- Base URL: `https://api.arcee.ai/api/v1` (direct) or `https://openrouter.ai/api/v1` (OpenRouter) + +## Quick start + +1. Get an API key from [Arcee AI](https://chat.arcee.ai/) or [OpenRouter](https://openrouter.ai/keys). + +2. Set the API key (recommended: store it for the Gateway): + +```bash +# Direct (Arcee platform) +openclaw onboard --auth-choice arceeai-api-key + +# Via OpenRouter +openclaw onboard --auth-choice arceeai-openrouter +``` + +3. Set a default model: + +```json5 +{ + agents: { + defaults: { + model: { primary: "arcee/trinity-large-thinking" }, + }, + }, +} +``` + +## Non-interactive example + +```bash +# Direct (Arcee platform) +openclaw onboard --non-interactive \ + --mode local \ + --auth-choice arceeai-api-key \ + --arceeai-api-key "$ARCEEAI_API_KEY" + +# Via OpenRouter +openclaw onboard --non-interactive \ + --mode local \ + --auth-choice arceeai-openrouter \ + --openrouter-api-key "$OPENROUTER_API_KEY" +``` + +## Environment note + +If the Gateway runs as a daemon (launchd/systemd), make sure `ARCEEAI_API_KEY` +(or `OPENROUTER_API_KEY`) is available to that process (for example, in +`~/.openclaw/.env` or via `env.shellEnv`). + +## Built-in catalog + +OpenClaw currently ships this bundled Arcee catalog: + +| Model ref | Name | Input | Context | Cost (in/out per 1M) | Notes | +| ------------------------------ | ---------------------- | ----- | ------- | -------------------- | ----------------------------------------- | +| `arcee/trinity-large-thinking` | Trinity Large Thinking | text | 256K | $0.25 / $0.90 | Default model; reasoning enabled | +| `arcee/trinity-large-preview` | Trinity Large Preview | text | 128K | $0.25 / $1.00 | General-purpose; 400B params, 13B active | +| `arcee/trinity-mini` | Trinity Mini 26B | text | 128K | $0.045 / $0.15 | Fast and cost-efficient; function calling | + +The same model refs work for both direct and OpenRouter setups (for example `arcee/trinity-large-thinking`). + +The onboarding preset sets `arcee/trinity-large-thinking` as the default model. + +## Supported features + +- Streaming +- Tool use / function calling +- Structured output (JSON mode and JSON schema) +- Extended thinking (Trinity Large Thinking) diff --git a/docs/providers/index.md b/docs/providers/index.md index 5f0e47ba1..7cd5dcbab 100644 --- a/docs/providers/index.md +++ b/docs/providers/index.md @@ -29,6 +29,7 @@ Looking for chat channel docs (WhatsApp/Telegram/Discord/Slack/Mattermost (plugi - [Alibaba Model Studio](/providers/alibaba) - [Amazon Bedrock](/providers/bedrock) - [Anthropic (API + Claude CLI)](/providers/anthropic) +- [Arcee AI (Trinity models)](/providers/arcee) - [BytePlus (International)](/concepts/model-providers#byteplus-international) - [Chutes](/providers/chutes) - [ComfyUI](/providers/comfy)