mirror of
https://github.com/openclaw/openclaw.git
synced 2026-03-13 11:00:50 +00:00
d92ba4f8aa
* Onboard: add Mistral auth choice and CLI flags * Onboard/Auth: add Mistral provider config defaults * Auth choice: wire Mistral API-key flow * Onboard non-interactive: support --mistral-api-key * Media understanding: add Mistral Voxtral audio provider * Changelog: note Mistral onboarding and media support * Docs: add Mistral provider and onboarding/media references * Tests: cover Mistral media registry/defaults and auth mapping * Memory: add Mistral embeddings provider support * Onboarding: refresh Mistral model metadata * Docs: document Mistral embeddings and endpoints * Memory: persist Mistral embedding client state in managers * Memory: add regressions for mistral provider wiring * Gateway: add live tool probe retry helper * Gateway: cover live tool probe retry helper * Gateway: retry malformed live tool-read probe responses * Memory: support plain-text batch error bodies * Tests: add Mistral Voxtral live transcription smoke * Docs: add Mistral live audio test command * Revert: remove Mistral live voice test and docs entry * Onboard: re-export Mistral default model ref from models * Changelog: credit joeVenner for Mistral work * fix: include Mistral in auto audio key fallback * Update CHANGELOG.md * Update CHANGELOG.md --------- Co-authored-by: Shakker <shakkerdroid@gmail.com>
169 lines
4.6 KiB
Markdown
169 lines
4.6 KiB
Markdown
---
|
|
summary: "Scripted onboarding and agent setup for the OpenClaw CLI"
|
|
read_when:
|
|
- You are automating onboarding in scripts or CI
|
|
- You need non-interactive examples for specific providers
|
|
title: "CLI Automation"
|
|
sidebarTitle: "CLI automation"
|
|
---
|
|
|
|
# CLI Automation
|
|
|
|
Use `--non-interactive` to automate `openclaw onboard`.
|
|
|
|
<Note>
|
|
`--json` does not imply non-interactive mode. Use `--non-interactive` (and `--workspace`) for scripts.
|
|
</Note>
|
|
|
|
## Baseline non-interactive example
|
|
|
|
```bash
|
|
openclaw onboard --non-interactive \
|
|
--mode local \
|
|
--auth-choice apiKey \
|
|
--anthropic-api-key "$ANTHROPIC_API_KEY" \
|
|
--gateway-port 18789 \
|
|
--gateway-bind loopback \
|
|
--install-daemon \
|
|
--daemon-runtime node \
|
|
--skip-skills
|
|
```
|
|
|
|
Add `--json` for a machine-readable summary.
|
|
|
|
## Provider-specific examples
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="Gemini example">
|
|
```bash
|
|
openclaw onboard --non-interactive \
|
|
--mode local \
|
|
--auth-choice gemini-api-key \
|
|
--gemini-api-key "$GEMINI_API_KEY" \
|
|
--gateway-port 18789 \
|
|
--gateway-bind loopback
|
|
```
|
|
</Accordion>
|
|
<Accordion title="Z.AI example">
|
|
```bash
|
|
openclaw onboard --non-interactive \
|
|
--mode local \
|
|
--auth-choice zai-api-key \
|
|
--zai-api-key "$ZAI_API_KEY" \
|
|
--gateway-port 18789 \
|
|
--gateway-bind loopback
|
|
```
|
|
</Accordion>
|
|
<Accordion title="Vercel AI Gateway example">
|
|
```bash
|
|
openclaw onboard --non-interactive \
|
|
--mode local \
|
|
--auth-choice ai-gateway-api-key \
|
|
--ai-gateway-api-key "$AI_GATEWAY_API_KEY" \
|
|
--gateway-port 18789 \
|
|
--gateway-bind loopback
|
|
```
|
|
</Accordion>
|
|
<Accordion title="Cloudflare AI Gateway example">
|
|
```bash
|
|
openclaw onboard --non-interactive \
|
|
--mode local \
|
|
--auth-choice cloudflare-ai-gateway-api-key \
|
|
--cloudflare-ai-gateway-account-id "your-account-id" \
|
|
--cloudflare-ai-gateway-gateway-id "your-gateway-id" \
|
|
--cloudflare-ai-gateway-api-key "$CLOUDFLARE_AI_GATEWAY_API_KEY" \
|
|
--gateway-port 18789 \
|
|
--gateway-bind loopback
|
|
```
|
|
</Accordion>
|
|
<Accordion title="Moonshot example">
|
|
```bash
|
|
openclaw onboard --non-interactive \
|
|
--mode local \
|
|
--auth-choice moonshot-api-key \
|
|
--moonshot-api-key "$MOONSHOT_API_KEY" \
|
|
--gateway-port 18789 \
|
|
--gateway-bind loopback
|
|
```
|
|
</Accordion>
|
|
<Accordion title="Mistral example">
|
|
```bash
|
|
openclaw onboard --non-interactive \
|
|
--mode local \
|
|
--auth-choice mistral-api-key \
|
|
--mistral-api-key "$MISTRAL_API_KEY" \
|
|
--gateway-port 18789 \
|
|
--gateway-bind loopback
|
|
```
|
|
</Accordion>
|
|
<Accordion title="Synthetic example">
|
|
```bash
|
|
openclaw onboard --non-interactive \
|
|
--mode local \
|
|
--auth-choice synthetic-api-key \
|
|
--synthetic-api-key "$SYNTHETIC_API_KEY" \
|
|
--gateway-port 18789 \
|
|
--gateway-bind loopback
|
|
```
|
|
</Accordion>
|
|
<Accordion title="OpenCode Zen example">
|
|
```bash
|
|
openclaw onboard --non-interactive \
|
|
--mode local \
|
|
--auth-choice opencode-zen \
|
|
--opencode-zen-api-key "$OPENCODE_API_KEY" \
|
|
--gateway-port 18789 \
|
|
--gateway-bind loopback
|
|
```
|
|
</Accordion>
|
|
<Accordion title="Custom provider example">
|
|
```bash
|
|
openclaw onboard --non-interactive \
|
|
--mode local \
|
|
--auth-choice custom-api-key \
|
|
--custom-base-url "https://llm.example.com/v1" \
|
|
--custom-model-id "foo-large" \
|
|
--custom-api-key "$CUSTOM_API_KEY" \
|
|
--custom-provider-id "my-custom" \
|
|
--custom-compatibility anthropic \
|
|
--gateway-port 18789 \
|
|
--gateway-bind loopback
|
|
```
|
|
|
|
`--custom-api-key` is optional. If omitted, onboarding checks `CUSTOM_API_KEY`.
|
|
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
## Add another agent
|
|
|
|
Use `openclaw agents add <name>` to create a separate agent with its own workspace,
|
|
sessions, and auth profiles. Running without `--workspace` launches the wizard.
|
|
|
|
```bash
|
|
openclaw agents add work \
|
|
--workspace ~/.openclaw/workspace-work \
|
|
--model openai/gpt-5.2 \
|
|
--bind whatsapp:biz \
|
|
--non-interactive \
|
|
--json
|
|
```
|
|
|
|
What it sets:
|
|
|
|
- `agents.list[].name`
|
|
- `agents.list[].workspace`
|
|
- `agents.list[].agentDir`
|
|
|
|
Notes:
|
|
|
|
- Default workspaces follow `~/.openclaw/workspace-<agentId>`.
|
|
- Add `bindings` to route inbound messages (the wizard can do this).
|
|
- Non-interactive flags: `--model`, `--agent-dir`, `--bind`, `--non-interactive`.
|
|
|
|
## Related docs
|
|
|
|
- Onboarding hub: [Onboarding Wizard (CLI)](/start/wizard)
|
|
- Full reference: [CLI Onboarding Reference](/start/wizard-cli-reference)
|
|
- Command reference: [`openclaw onboard`](/cli/onboard)
|