CLI commands
Onboarden
openclaw onboard
Interactieve introductie voor lokale of externe Gateway-configuratie.
Gerelateerde gidsen
Stapsgewijze uitleg van de interactieve CLI-flow.
Hoe de OpenClaw-introductie samenhangt.
Uitvoer, interne werking en gedrag per stap.
Niet-interactieve flags en gescripte configuraties.
Introductieflow voor de macOS-menubalkapp.
Voorbeelden
openclaw onboard
openclaw onboard --modern
openclaw onboard --flow quickstart
openclaw onboard --flow manual
openclaw onboard --flow import
openclaw onboard --import-from hermes --import-source ~/.hermes
openclaw onboard --skip-bootstrap
openclaw onboard --mode remote --remote-url wss://gateway-host:18789
--flow import gebruikt door plugins beheerde migratieproviders zoals Hermes. Het wordt alleen uitgevoerd op een verse OpenClaw-configuratie; als bestaande configuratie, referenties, sessies of bestanden voor werkruimtegeheugen/identiteit aanwezig zijn, reset dan of kies een verse configuratie voordat je importeert.
--modern start de preview van de conversatie-introductie van Crestodian. Zonder
--modern behoudt openclaw onboard de klassieke introductieflow.
Voor plaintext private-network ws://-doelen (alleen vertrouwde netwerken) stel je
OPENCLAW_ALLOW_INSECURE_PRIVATE_WS=1 in de procesomgeving voor introductie in.
Er is geen equivalent in openclaw.json voor deze noodoptie voor
client-side transport.
Niet-interactieve aangepaste provider:
openclaw onboard --non-interactive \
--auth-choice custom-api-key \
--custom-base-url "https://llm.example.com/v1" \
--custom-model-id "foo-large" \
--custom-api-key "$CUSTOM_API_KEY" \
--secret-input-mode plaintext \
--custom-compatibility openai \
--custom-image-input
--custom-api-key is optioneel in niet-interactieve modus. Als deze wordt weggelaten, controleert de introductie CUSTOM_API_KEY.
OpenClaw markeert gangbare vision-model-ID's automatisch als geschikt voor afbeeldingen. Geef --custom-image-input door voor onbekende aangepaste vision-ID's, of --custom-text-input om metadata voor alleen tekst af te dwingen.
LM Studio ondersteunt ook een providerspecifieke key-flag in niet-interactieve modus:
openclaw onboard --non-interactive \
--auth-choice lmstudio \
--custom-base-url "http://localhost:1234/v1" \
--custom-model-id "qwen/qwen3.5-9b" \
--lmstudio-api-key "$LM_API_TOKEN" \
--accept-risk
Niet-interactieve Ollama:
openclaw onboard --non-interactive \
--auth-choice ollama \
--custom-base-url "http://ollama-host:11434" \
--custom-model-id "qwen3.5:27b" \
--accept-risk
--custom-base-url gebruikt standaard http://127.0.0.1:11434. --custom-model-id is optioneel; als deze wordt weggelaten, gebruikt de introductie de voorgestelde standaardinstellingen van Ollama. Cloudmodel-ID's zoals kimi-k2.5:cloud werken hier ook.
Sla providersleutels op als verwijzingen in plaats van plaintext:
openclaw onboard --non-interactive \
--auth-choice openai-api-key \
--secret-input-mode ref \
--accept-risk
Met --secret-input-mode ref schrijft de introductie door omgevingsvariabelen ondersteunde verwijzingen in plaats van plaintext sleutelwaarden.
Voor providers die door auth-profielen worden ondersteund, schrijft dit keyRef-items; voor aangepaste providers schrijft dit models.providers.<id>.apiKey als een omgevingsverwijzing (bijvoorbeeld { source: "env", provider: "default", id: "CUSTOM_API_KEY" }).
Contract voor niet-interactieve ref-modus:
- Stel de omgevingsvariabele van de provider in de procesomgeving voor introductie in (bijvoorbeeld
OPENAI_API_KEY). - Geef geen inline key-flags door (bijvoorbeeld
--openai-api-key), tenzij die omgevingsvariabele ook is ingesteld. - Als een inline key-flag wordt doorgegeven zonder de vereiste omgevingsvariabele, stopt de introductie snel met begeleiding.
Gateway-tokenopties in niet-interactieve modus:
--gateway-auth token --gateway-token <token>slaat een plaintext token op.--gateway-auth token --gateway-token-ref-env <name>slaatgateway.auth.tokenop als een omgevings-SecretRef.--gateway-tokenen--gateway-token-ref-envsluiten elkaar uit.--gateway-token-ref-envvereist een niet-lege omgevingsvariabele in de procesomgeving voor introductie.- Met
--install-daemon, wanneer tokenauthenticatie een token vereist, worden door SecretRef beheerde Gateway-tokens gevalideerd maar niet als opgeloste plaintext opgeslagen in omgevingsmetadata van de supervisorservice. - Met
--install-daemon, als de tokenmodus een token vereist en de geconfigureerde token-SecretRef niet kan worden opgelost, faalt de introductie gesloten met herstelbegeleiding. - Met
--install-daemon, als zowelgateway.auth.tokenalsgateway.auth.passwordzijn geconfigureerd engateway.auth.modeniet is ingesteld, blokkeert de introductie de installatie totdat de modus expliciet is ingesteld. - Lokale introductie schrijft
gateway.mode="local"naar de configuratie. Als in een later configuratiebestandgateway.modeontbreekt, behandel dat dan als configuratieschade of een onvolledige handmatige bewerking, niet als een geldige snelkoppeling voor lokale modus. - Lokale introductie installeert geselecteerde downloadbare plugins wanneer het gekozen configuratiepad deze vereist.
- Externe introductie schrijft alleen verbindingsinformatie voor de externe Gateway en installeert geen lokale pluginpakketten.
--allow-unconfiguredis een afzonderlijke ontsnappingsoptie voor de Gateway-runtime. Het betekent niet dat de introductiegateway.modemag weglaten.
Voorbeeld:
export OPENCLAW_GATEWAY_TOKEN="your-token"
openclaw onboard --non-interactive \
--mode local \
--auth-choice skip \
--gateway-auth token \
--gateway-token-ref-env OPENCLAW_GATEWAY_TOKEN \
--accept-risk
Niet-interactieve lokale Gateway-status:
- Tenzij je
--skip-healthdoorgeeft, wacht de introductie op een bereikbare lokale gateway voordat deze succesvol afsluit. --install-daemonstart eerst het installatiepad voor de beheerde Gateway. Zonder deze optie moet je al een lokale Gateway hebben draaien, bijvoorbeeldopenclaw gateway run.- Als je in automatisering alleen configuratie-/werkruimte-/bootstrap-schrijfacties wilt, gebruik dan
--skip-health. - Als je werkruimtebestanden zelf beheert, geef dan
--skip-bootstrapdoor omagents.defaults.skipBootstrap: truein te stellen en het aanmaken vanAGENTS.md,SOUL.md,TOOLS.md,IDENTITY.md,USER.md,HEARTBEAT.mdenBOOTSTRAP.mdover te slaan. - Op native Windows probeert
--install-daemoneerst Scheduled Tasks en valt terug op een login-item in de Startup-map per gebruiker als het aanmaken van de taak wordt geweigerd.
Interactief introductiegedrag met verwijzingsmodus:
- Kies Geheime verwijzing gebruiken wanneer daarom wordt gevraagd.
- Kies daarna een van beide:
- Omgevingsvariabele
- Geconfigureerde geheime provider (
fileofexec)
- De introductie voert een snelle preflightvalidatie uit voordat de verwijzing wordt opgeslagen.
- Als de validatie mislukt, toont de introductie de fout en kun je het opnieuw proberen.
Niet-interactieve Z.AI-endpointkeuzes
# Promptless endpoint selection
openclaw onboard --non-interactive \
--auth-choice zai-coding-global \
--zai-api-key "$ZAI_API_KEY"
# Other Z.AI endpoint choices:
# --auth-choice zai-coding-cn
# --auth-choice zai-global
# --auth-choice zai-cn
Niet-interactief Mistral-voorbeeld:
openclaw onboard --non-interactive \
--auth-choice mistral-api-key \
--mistral-api-key "$MISTRAL_API_KEY"
Flow-opmerkingen
Flowtypen
quickstart: minimale prompts, genereert automatisch een Gateway-token.manual: volledige prompts voor poort, bind en auth (alias vanadvanced).import: voert een gedetecteerde migratieprovider uit, toont een preview van het plan en past dit vervolgens toe na bevestiging.
Provider-prefiltering
Wanneer een auth-keuze een voorkeursprovider impliceert, filtert de introductie vooraf de standaardmodel- en allowlist-kiezers op die provider. Voor Volcengine en BytePlus matcht dit ook de Coding Plan-varianten (volcengine-plan/*, byteplus-plan/*).
Als het voorkeursproviderfilter nog geen geladen modellen oplevert, valt de introductie terug op de ongefilterde catalogus in plaats van de kiezer leeg te laten.
Vervolgprompts voor webzoekopdrachten
Sommige providers voor webzoekopdrachten activeren providerspecifieke vervolgprompts:
- Grok kan optionele
x_search-configuratie aanbieden met dezelfdeXAI_API_KEYen eenx_search-modelkeuze. - Kimi kan vragen naar de Moonshot API-regio (
api.moonshot.aiversusapi.moonshot.cn) en het standaard Kimi-model voor webzoekopdrachten.
Ander gedrag
- Gedrag van DM-scope bij lokale introductie: CLI-configuratiereferentie.
- Snelste eerste chat:
openclaw dashboard(Control UI, geen kanaalconfiguratie). - Aangepaste provider: verbind elk OpenAI- of Anthropic-compatibel endpoint, inclusief gehoste providers die niet worden vermeld. Gebruik Unknown om automatisch te detecteren.
- Als Hermes-status wordt gedetecteerd, biedt de introductie een migratieflow aan. Gebruik Migreren voor dry-run-plannen, overschrijfmodus, rapporten en exacte mappings.
Veelgebruikte vervolgcommando's
openclaw configure
openclaw agents add <name>