packages/web/src/content/docs/nb/cli.mdx
import { Tabs, TabItem } from "@astrojs/starlight/components"
OpenCode CLI starter som standard TUI når den kjøres uten noen argumenter.
opencode
Men den godtar også kommandoer som dokumentert på denne siden. Dette lar deg samhandle med OpenCode programmatisk.
opencode run "Explain how closures work in JavaScript"
Start OpenCode-terminalbrukergrensesnittet.
opencode [project]
| Flagg | Kort | Beskrivelse |
|---|---|---|
| <nobr><code>{"--continue"}</code></nobr> | -c | Fortsett siste økt |
| <nobr><code>{"--session"}</code></nobr> | -s | Økt ID for å fortsette |
| <nobr><code>{"--fork"}</code></nobr> | Forgren økten ved fortsettelse (bruk med --continue eller --session) | |
| <nobr><code>{"--prompt"}</code></nobr> | Ledetekst som skal brukes | |
| <nobr><code>{"--model"}</code></nobr> | -m | Modell å bruke i form av leverandør/modell |
| <nobr><code>{"--agent"}</code></nobr> | Agent som skal brukes | |
| <nobr><code>{"--port"}</code></nobr> | Port å lytte på | |
| <nobr><code>{"--hostname"}</code></nobr> | Vertsnavn å lytte på |
OpenCode CLI har også følgende kommandoer.
Administrer agenter for OpenCode.
opencode agent [command]
Koble en terminal til en allerede kjørende OpenCode-backend-server startet via serve eller web kommandoer.
opencode attach [url]
Dette gjør det mulig å bruke TUI med en ekstern OpenCode-backend. For eksempel:
# Start the backend server for web/mobile access
opencode web --port 4096 --hostname 0.0.0.0
# In another terminal, attach the TUI to the running backend
opencode attach http://10.20.30.40:4096
| Flagg | Kort | Beskrivelse |
|---|---|---|
| <nobr><code>{"--dir"}</code></nobr> | Arbeidskatalog for å starte TUI i | |
| <nobr><code>{"--continue"}</code></nobr> | -c | Fortsett siste økt |
| <nobr><code>{"--session"}</code></nobr> | -s | Økt ID for å fortsette |
| <nobr><code>{"--fork"}</code></nobr> | Forgren økten ved fortsettelse (bruk med --continue eller --session) | |
| <nobr><code>{"--password"}</code></nobr> | -p | Passord for grunnleggende autentisering (standard: OPENCODE_SERVER_PASSWORD) |
| <nobr><code>{"--username"}</code></nobr> | -u | Brukernavn for grunnleggende autentisering (standard: OPENCODE_SERVER_USERNAME eller opencode) |
Opprett en ny agent med tilpasset konfigurasjon.
opencode agent create
Denne kommandoen vil veilede deg gjennom å lage en ny agent med en tilpasset systemmelding og verktøykonfigurasjon.
List opp alle tilgjengelige agenter.
opencode agent list
Kommando for administrasjon av påloggingsinformasjon og innlogging for leverandører.
opencode auth [command]
OpenCode drives av leverandørlisten på Models.dev, så du kan bruke opencode auth login til å konfigurere API-nøkler for enhver leverandør du vil bruke. Dette er lagret i ~/.local/share/opencode/auth.json.
opencode auth login
Når OpenCode starter opp, laster den leverandørene fra filen med påloggingsinformasjon. Og hvis det er noen nøkler definert i miljøene dine eller en .env-fil i prosjektet ditt.
Viser alle de autentiserte leverandørene som er lagret i filen med påloggingsinformasjon.
opencode auth list
Eller bruk kortversjonen.
opencode auth ls
Logger deg ut av en leverandør ved å fjerne den fra filen med påloggingsinformasjon.
opencode auth logout
Administrer GitHub-agenten for depotautomatisering.
opencode github [command]
Installer GitHub-agenten i depotet ditt.
opencode github install
Dette setter opp den nødvendige GitHub Actions-arbeidsflyten og veileder deg gjennom konfigurasjonsprosessen. Finn ut mer.
Kjør GitHub-agenten. Dette brukes vanligvis i GitHub Actions.
opencode github run
| Flagg | Beskrivelse |
|---|---|
| <nobr><code>{"--event"}</code></nobr> | GitHub mock-hendelse agenten skal kjøres for |
| <nobr><code>{"--token"}</code></nobr> | GitHub personlig tilgangsnøkkel |
Administrer Model Context Protocol-servere.
opencode mcp [command]
Legg til en MCP-server til konfigurasjonen.
opencode mcp add
Denne kommandoen vil veilede deg gjennom å legge til enten en lokal eller ekstern MCP-server.
Liste alle konfigurerte MCP-servere og deres tilkoblingsstatus.
opencode mcp list
Eller bruk den korte versjonen.
opencode mcp ls
Autentiser med en OAuth-aktivert MCP-server.
opencode mcp auth [name]
Hvis du ikke oppgir et servernavn, blir du bedt om å velge blant tilgjengelige OAuth-kompatible servere.
Du kan også liste opp OAuth-kompatible servere og deres autentiseringsstatus.
opencode mcp auth list
Eller bruk den korte versjonen.
opencode mcp auth ls
Fjern OAuth-påloggingsinformasjon for en MCP-server.
opencode mcp logout [name]
Feilsøk OAuth-tilkoblingsproblemer for en MCP-server.
opencode mcp debug <name>
List opp alle tilgjengelige modeller fra konfigurerte leverandører.
opencode models [provider]
Denne kommandoen viser alle modeller som er tilgjengelige på tvers av dine konfigurerte leverandører i formatet provider/model.
Dette er nyttig for å finne ut det eksakte modellnavnet som skal brukes i din konfigurasjon.
Du kan eventuelt sende en leverandør ID for å filtrere modeller etter den leverandøren.
opencode models anthropic
| Flagg | Beskrivelse |
|---|---|
| <nobr><code>{"--refresh"}</code></nobr> | Oppdater modellbufferen fra models.dev |
| <nobr><code>{"--verbose"}</code></nobr> | Bruk mer detaljert modellutdata (inkluderer metadata som kostnader) |
Bruk --refresh-flagget for å oppdatere den bufrede modelllisten. Dette er nyttig når nye modeller er lagt til en leverandør og du vil se dem i OpenCode.
opencode models --refresh
Kjør OpenCode i ikke-interaktiv modus ved å sende en melding direkte.
opencode run [message..]
Dette er nyttig for skripting, automatisering eller når du vil ha et raskt svar uten å starte hele TUI. For eksempel.
opencode run Explain the use of context in Go
Du kan også koble til en kjørende opencode serve-forekomst for å unngå MCP-serveres kaldstarttid ved hver kjøring:
# Start a headless server in one terminal
opencode serve
# In another terminal, run commands that attach to it
opencode run --attach http://localhost:4096 "Explain async/await in JavaScript"
| Flagg | Kort | Beskrivelse |
|---|---|---|
| <nobr><code>{"--command"}</code></nobr> | Kommandoen for å kjøre, bruk melding for args | |
| <nobr><code>{"--continue"}</code></nobr> | -c | Fortsett siste økt |
| <nobr><code>{"--session"}</code></nobr> | -s | Økt ID for å fortsette |
| <nobr><code>{"--fork"}</code></nobr> | Forgren økten ved fortsettelse (bruk med --continue eller --session) | |
| <nobr><code>{"--share"}</code></nobr> | Del økten | |
| <nobr><code>{"--model"}</code></nobr> | -m | Modell å bruke i form av leverandør/modell |
| <nobr><code>{"--agent"}</code></nobr> | Agent å bruke | |
| <nobr><code>{"--file"}</code></nobr> | -f | Fil(er) som skal legges ved meldingen |
| <nobr><code>{"--format"}</code></nobr> | Format: standard (formatert) eller json (rå JSON hendelser) | |
| <nobr><code>{"--title"}</code></nobr> | Tittel for økten (bruker avkortet ledetekst hvis ingen verdi er oppgitt) | |
| <nobr><code>{"--attach"}</code></nobr> | Koble til en kjørende OpenCode-server (f.eks. http://localhost:4096) | |
| <nobr><code>{"--password"}</code></nobr> | -p | Passord for grunnleggende autentisering (standard: OPENCODE_SERVER_PASSWORD) |
| <nobr><code>{"--username"}</code></nobr> | -u | Brukernavn for grunnleggende autentisering (standard: OPENCODE_SERVER_USERNAME eller opencode) |
| <nobr><code>{"--dir"}</code></nobr> | Katalog å kjøre i, eller sti på fjernserveren ved tilkobling | |
| <nobr><code>{"--variant"}</code></nobr> | Modellvariant (leverandørspesifikk resonneringsinnsats) | |
| <nobr><code>{"--thinking"}</code></nobr> | Vis tenkeblokker | |
| <nobr><code>{"--port"}</code></nobr> | Port for den lokale serveren (standard til tilfeldig port) |
Start en headless OpenCode-server for API-tilgang. Sjekk ut server-dokumentene for hele HTTP-grensesnittet.
opencode serve
Dette starter en HTTP-server som gir API tilgang til OpenCode-funksjonalitet uten TUI-grensesnittet. Sett OPENCODE_SERVER_PASSWORD for å aktivere HTTP grunnleggende autentisering (brukernavn er standard til opencode).
| Flagg | Beskrivelse |
|---|---|
| <nobr><code>{"--port"}</code></nobr> | Port å lytte på |
| <nobr><code>{"--hostname"}</code></nobr> | Vertsnavn å lytte på |
| <nobr><code>{"--mdns"}</code></nobr> | Aktiver mDNS-oppdagelse |
| <nobr><code>{"--cors"}</code></nobr> | Ytterligere nettleseropprinnelse som tillater CORS |
Administrer OpenCode-økter.
opencode session [command]
List opp alle OpenCode-økter.
opencode session list
| Flagg | Kort | Beskrivelse |
|---|---|---|
| <nobr><code>{"--max-count"}</code></nobr> | -n | Begrens til N siste økter |
| <nobr><code>{"--format"}</code></nobr> | Utdataformat: tabell eller json (tabell) |
Vis tokenbruk og kostnadsstatistikk for OpenCode-øktene dine.
opencode stats
| Flagg | Beskrivelse |
|---|---|
| <nobr><code>{"--days"}</code></nobr> | Vis statistikk for de siste N dagene (hele tiden) |
| <nobr><code>{"--tools"}</code></nobr> | Antall verktøy som skal vises (alle) |
| <nobr><code>{"--models"}</code></nobr> | Vis oversikt over modellbruk (skjult som standard). Gi et tall for å vise topp N |
| <nobr><code>{"--project"}</code></nobr> | Filtrer etter prosjekt (alle prosjekter, tom streng: gjeldende prosjekt) |
Eksporter øktdata som JSON.
opencode export [sessionID]
Hvis du ikke gir en økt ID, blir du bedt om å velge fra tilgjengelige økter.
Importer øktdata fra en JSON-fil eller en OpenCode share-URL.
opencode import <file>
Du kan importere fra en lokal fil eller en OpenCode share-URL.
opencode import session.json
opencode import https://opncd.ai/s/abc123
Start en headless OpenCode-server med et webgrensesnitt.
opencode web
Dette starter en HTTP-server og åpner en nettleser for å få tilgang til OpenCode via et nettgrensesnitt. Sett OPENCODE_SERVER_PASSWORD for å aktivere HTTP grunnleggende autentisering (brukernavn er standard til opencode).
| Flagg | Beskrivelse |
|---|---|
| <nobr><code>{"--port"}</code></nobr> | Port å lytte på |
| <nobr><code>{"--hostname"}</code></nobr> | Vertsnavn å lytte på |
| <nobr><code>{"--mdns"}</code></nobr> | Aktiver mDNS-oppdagelse |
| <nobr><code>{"--cors"}</code></nobr> | Ytterligere nettleseropprinnelse som tillater CORS |
Start en ACP (Agent Client Protocol) server.
opencode acp
Denne kommandoen starter en ACP-server som kommuniserer via stdin/stdout ved å bruke nd-JSON.
| Flagg | Beskrivelse |
|---|---|
| <nobr><code>{"--cwd"}</code></nobr> | Arbeidskatalog |
| <nobr><code>{"--port"}</code></nobr> | Port å lytte på |
| <nobr><code>{"--hostname"}</code></nobr> | Vertsnavn å lytte på |
Avinstaller OpenCode og fjern alle relaterte filer.
opencode uninstall
| Flagg | Kort | Beskrivelse |
|---|---|---|
| <nobr><code>{"--keep-config"}</code></nobr> | -c | Behold konfigurasjonsfiler |
| <nobr><code>{"--keep-data"}</code></nobr> | -d | Behold øktdata og øyeblikksbilder |
| <nobr><code>{"--dry-run"}</code></nobr> | Vis hva som ville blitt fjernet uten å fjerne | |
| <nobr><code>{"--force"}</code></nobr> | -f | Hopp over bekreftelsesforespørsler |
Oppdaterer OpenCode til siste versjon eller en spesifikk versjon.
opencode upgrade [target]
For å oppgradere til siste versjon.
opencode upgrade
For å oppgradere til en bestemt versjon.
opencode upgrade v0.1.48
| Flagg | Kort | Beskrivelse |
|---|---|---|
| <nobr><code>{"--method"}</code></nobr> | -m | Installasjonsmetoden som ble brukt: curl, npm, pnpm, bun, brew |
OpenCode CLI bruker følgende globale flagg.
| Flagg | Kort | Beskrivelse |
|---|---|---|
| <nobr><code>{"--help"}</code></nobr> | -h | Vis hjelp |
| <nobr><code>{"--version"}</code></nobr> | -v | Skriv ut versjonsnummer |
| <nobr><code>{"--print-logs"}</code></nobr> | Skriv ut logger til stderr | |
| <nobr><code>{"--log-level"}</code></nobr> | Loggnivå (DEBUG, INFO, WARN, ERROR) |
OpenCode kan konfigureres ved hjelp av miljøvariabler.
| Variabel | Type | Beskrivelse |
|---|---|---|
OPENCODE_AUTO_SHARE | boolsk | Del økter automatisk |
OPENCODE_GIT_BASH_PATH | streng | Bane til Git Bash-kjørbar på Windows |
OPENCODE_CONFIG | streng | Bane til konfigurasjonsfil |
OPENCODE_TUI_CONFIG | streng | Bane til TUI-konfigurasjonsfil |
OPENCODE_CONFIG_DIR | streng | Bane til konfigurasjonskatalog |
OPENCODE_CONFIG_CONTENT | streng | Innebygd json-konfigurasjonsinnhold |
OPENCODE_DISABLE_AUTOUPDATE | boolsk | Deaktiver automatiske oppdateringskontroller |
OPENCODE_DISABLE_PRUNE | boolsk | Deaktiver beskjæring av gamle data |
OPENCODE_DISABLE_TERMINAL_TITLE | boolsk | Deaktiver automatiske terminaltitteloppdateringer |
OPENCODE_PERMISSION | streng | Innebygd json-tillatelseskonfigurasjon |
OPENCODE_DISABLE_DEFAULT_PLUGINS | boolsk | Deaktiver standard plugins |
OPENCODE_DISABLE_LSP_DOWNLOAD | boolsk | Deaktiver automatiske LSP servernedlastinger |
OPENCODE_ENABLE_EXPERIMENTAL_MODELS | boolsk | Aktiver eksperimentelle modeller |
OPENCODE_DISABLE_AUTOCOMPACT | boolsk | Deaktiver automatisk kontekstkomprimering |
OPENCODE_DISABLE_CLAUDE_CODE | boolsk | Deaktiver lesing fra .claude (spørsmål + ferdigheter) |
OPENCODE_DISABLE_CLAUDE_CODE_PROMPT | boolsk | Deaktiver lesing ~/.claude/CLAUDE.md |
OPENCODE_DISABLE_CLAUDE_CODE_SKILLS | boolsk | Deaktiver innlasting av .claude/skills |
OPENCODE_DISABLE_MODELS_FETCH | boolsk | Deaktiver henting av modeller fra eksterne kilder |
OPENCODE_FAKE_VCS | streng | Falsk VCS-leverandør for testformål |
OPENCODE_CLIENT | streng | Klientidentifikator (standard til cli) |
OPENCODE_ENABLE_EXA | boolsk | Aktiver Exa-nettsøkeverktøy |
OPENCODE_SERVER_PASSWORD | streng | Aktiver grunnleggende autentisering for serve/web |
OPENCODE_SERVER_USERNAME | streng | Overstyr grunnleggende autentiseringsbrukernavn (standard opencode) |
OPENCODE_MODELS_URL | streng | Egendefinert URL for henting av modellkonfigurasjon |
Disse miljøvariablene muliggjør eksperimentelle funksjoner som kan endres eller fjernes.
| Variabel | Type | Beskrivelse |
|---|---|---|
OPENCODE_EXPERIMENTAL | boolsk | Aktiver alle eksperimentelle funksjoner |
OPENCODE_EXPERIMENTAL_ICON_DISCOVERY | boolsk | Aktiver ikonoppdagelse |
OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECT | boolsk | Deaktiver kopi ved valg i TUI |
OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS | tall | Standard tidsavbrudd for bash-kommandoer i ms |
OPENCODE_EXPERIMENTAL_OUTPUT_TOKEN_MAX | tall | Maks Output Tokens for LLM-svar |
OPENCODE_EXPERIMENTAL_FILEWATCHER | boolsk | Aktiver filovervåker for hele dir |
OPENCODE_EXPERIMENTAL_OXFMT | boolsk | Aktiver oxfmt formatter |
OPENCODE_EXPERIMENTAL_LSP_TOOL | boolsk | Aktiver eksperimentelt LSP-verktøy |
OPENCODE_EXPERIMENTAL_DISABLE_FILEWATCHER | boolsk | Deaktiver filovervåking |
OPENCODE_EXPERIMENTAL_EXA | boolsk | Aktiver eksperimentelle Exa-funksjoner |
OPENCODE_EXPERIMENTAL_LSP_TY | boolsk | Aktiver TY LSP for python-filer |
OPENCODE_EXPERIMENTAL_MARKDOWN | boolsk | Aktiver eksperimentelle Markdown-funksjoner |
OPENCODE_EXPERIMENTAL_PLAN_MODE | boolsk | Aktiver planmodus |