Hopp til innholdet
V1-dokumentasjon
tui

CLI

OpenCode CLI starter som standard TUI når den kjøres uten noen argumenter.

Terminal
opencode

Men den godtar også kommandoer som dokumentert på denne siden. Dette lar deg samhandle med OpenCode programmatisk.

Terminal
opencode run "Explain how closures work in JavaScript"

Start OpenCode-terminalbrukergrensesnittet.

Terminal
opencode [project]

Flagg

FlaggKortBeskrivelse
--continue-cFortsett siste økt
--session-sØkt ID for å fortsette
--forkForgren økten ved fortsettelse (bruk med --continue eller --session)
--promptLedetekst som skal brukes
--model-mModell å bruke i form av leverandør/modell
--agentAgent som skal brukes
--portPort å lytte på
--hostnameVertsnavn å lytte på

OpenCode CLI har også følgende kommandoer.


Koble en terminal til en allerede kjørende OpenCode-backend-server startet via serve eller web kommandoer.

Terminal
opencode attach [url]

Dette gjør det mulig å bruke TUI med en ekstern OpenCode-backend. For eksempel:

Terminal
# 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

FlaggKortBeskrivelse
--dirArbeidskatalog for å starte TUI i
--continue-cFortsett siste økt
--session-sØkt ID for å fortsette
--forkForgren økten ved fortsettelse (bruk med --continue eller --session)
--password-pPassord for grunnleggende autentisering (standard: OPENCODE_SERVER_PASSWORD)
--username-uBrukernavn for grunnleggende autentisering (standard: OPENCODE_SERVER_USERNAME eller opencode)

Kommando for administrasjon av påloggingsinformasjon og innlogging for leverandører.

Terminal
opencode auth [command]

login

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.

Terminal
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.


list

Viser alle de autentiserte leverandørene som er lagret i filen med påloggingsinformasjon.

Terminal
opencode auth list

Eller bruk kortversjonen.

Terminal
opencode auth ls

logout

Logger deg ut av en leverandør ved å fjerne den fra filen med påloggingsinformasjon.

Terminal
opencode auth logout

Administrer GitHub-agenten for depotautomatisering.

Terminal
opencode github [command]

install

Installer GitHub-agenten i depotet ditt.

Terminal
opencode github install

Dette setter opp den nødvendige GitHub Actions-arbeidsflyten og veileder deg gjennom konfigurasjonsprosessen. Finn ut mer.


run

Kjør GitHub-agenten. Dette brukes vanligvis i GitHub Actions.

Terminal
opencode github run
Flagg
FlaggBeskrivelse
--eventGitHub mock-hendelse agenten skal kjøres for
--tokenGitHub personlig tilgangsnøkkel

Administrer Model Context Protocol-servere.

Terminal
opencode mcp [command]

add

Legg til en MCP-server til konfigurasjonen.

Terminal
opencode mcp add

Denne kommandoen vil veilede deg gjennom å legge til enten en lokal eller ekstern MCP-server.


list

Liste alle konfigurerte MCP-servere og deres tilkoblingsstatus.

Terminal
opencode mcp list

Eller bruk den korte versjonen.

Terminal
opencode mcp ls

auth

Autentiser med en OAuth-aktivert MCP-server.

Terminal
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.

Terminal
opencode mcp auth list

Eller bruk den korte versjonen.

Terminal
opencode mcp auth ls

logout

Fjern OAuth-påloggingsinformasjon for en MCP-server.

Terminal
opencode mcp logout [name]

debug

Feilsøk OAuth-tilkoblingsproblemer for en MCP-server.

Terminal
opencode mcp debug <name>

List opp alle tilgjengelige modeller fra konfigurerte leverandører.

Terminal
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.

Terminal
opencode models anthropic

Flagg

FlaggBeskrivelse
--refreshOppdater modellbufferen fra models.dev
--verboseBruk 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.

Terminal
opencode models --refresh

Kjør OpenCode i ikke-interaktiv modus ved å sende en melding direkte.

Terminal
opencode run [message..]

Dette er nyttig for skripting, automatisering eller når du vil ha et raskt svar uten å starte hele TUI. For eksempel.

Terminal
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:

Terminal
# 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

FlaggKortBeskrivelse
--commandKommandoen for å kjøre, bruk melding for args
--continue-cFortsett siste økt
--session-sØkt ID for å fortsette
--forkForgren økten ved fortsettelse (bruk med --continue eller --session)
--model-mModell å bruke i form av leverandør/modell
--agentAgent å bruke
--file-fFil(er) som skal legges ved meldingen
--formatFormat: standard (formatert) eller json (rå JSON hendelser)
--titleTittel for økten (bruker avkortet ledetekst hvis ingen verdi er oppgitt)
--attachKoble til en kjørende OpenCode-server (f.eks. http://localhost:4096)
--password-pPassord for grunnleggende autentisering (standard: OPENCODE_SERVER_PASSWORD)
--username-uBrukernavn for grunnleggende autentisering (standard: OPENCODE_SERVER_USERNAME eller opencode)
--dirKatalog å kjøre i, eller sti på fjernserveren ved tilkobling
--variantModellvariant (leverandørspesifikk resonneringsinnsats)
--thinkingVis tenkeblokker
--portPort for den lokale serveren (standard til tilfeldig port)

Start en headless OpenCode-server for API-tilgang. Sjekk ut server-dokumentene for hele HTTP-grensesnittet.

Terminal
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

FlaggBeskrivelse
--portPort å lytte på
--hostnameVertsnavn å lytte på
--mdnsAktiver mDNS-oppdagelse
--corsYtterligere nettleseropprinnelse som tillater CORS

Administrer OpenCode-økter.

Terminal
opencode session [command]

list

List opp alle OpenCode-økter.

Terminal
opencode session list
Flagg
FlaggKortBeskrivelse
--max-count-nBegrens til N siste økter
--formatUtdataformat: tabell eller json (tabell)

Vis tokenbruk og kostnadsstatistikk for OpenCode-øktene dine.

Terminal
opencode stats

Flagg

FlaggBeskrivelse
--daysVis statistikk for de siste N dagene (hele tiden)
--toolsAntall verktøy som skal vises (alle)
--modelsVis oversikt over modellbruk (skjult som standard). Gi et tall for å vise topp N
--projectFiltrer etter prosjekt (alle prosjekter, tom streng: gjeldende prosjekt)

Eksporter øktdata som JSON.

Terminal
opencode export [sessionID]

Hvis du ikke gir en økt ID, blir du bedt om å velge fra tilgjengelige økter.


Importer øktdata fra en JSON-fil.

Terminal
opencode import <file>
Terminal
opencode import session.json

Start en headless OpenCode-server med et webgrensesnitt.

Terminal
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

FlaggBeskrivelse
--portPort å lytte på
--hostnameVertsnavn å lytte på
--mdnsAktiver mDNS-oppdagelse
--corsYtterligere nettleseropprinnelse som tillater CORS

Start en ACP (Agent Client Protocol) server.

Terminal
opencode acp

Denne kommandoen starter en ACP-server som kommuniserer via stdin/stdout ved å bruke nd-JSON.

Flagg

FlaggBeskrivelse
--cwdArbeidskatalog
--portPort å lytte på
--hostnameVertsnavn å lytte på

Avinstaller OpenCode og fjern alle relaterte filer.

Terminal
opencode uninstall

Flagg

FlaggKortBeskrivelse
--keep-config-cBehold konfigurasjonsfiler
--keep-data-dBehold øktdata og øyeblikksbilder
--dry-runVis hva som ville blitt fjernet uten å fjerne
--force-fHopp over bekreftelsesforespørsler

Oppdaterer OpenCode til siste versjon eller en spesifikk versjon.

Terminal
opencode upgrade [target]

For å oppgradere til siste versjon.

Terminal
opencode upgrade

For å oppgradere til en bestemt versjon.

Terminal
opencode upgrade v0.1.48

Flagg

FlaggKortBeskrivelse
--method-mInstallasjonsmetoden som ble brukt: curl, npm, pnpm, bun, brew

OpenCode CLI bruker følgende globale flagg.

FlaggKortBeskrivelse
--help-hVis hjelp
--version-vSkriv ut versjonsnummer
--print-logsSkriv ut logger til stderr
--log-levelLoggnivå (DEBUG, INFO, WARN, ERROR)

OpenCode kan konfigureres ved hjelp av miljøvariabler.

VariabelTypeBeskrivelse
OPENCODE_GIT_BASH_PATHstrengBane til Git Bash-kjørbar på Windows
OPENCODE_CONFIGstrengBane til konfigurasjonsfil
OPENCODE_TUI_CONFIGstrengBane til TUI-konfigurasjonsfil
OPENCODE_CONFIG_DIRstrengBane til konfigurasjonskatalog
OPENCODE_CONFIG_CONTENTstrengInnebygd json-konfigurasjonsinnhold
OPENCODE_DISABLE_AUTOUPDATEboolskDeaktiver automatiske oppdateringskontroller
OPENCODE_DISABLE_PRUNEboolskDeaktiver beskjæring av gamle data
OPENCODE_DISABLE_TERMINAL_TITLEboolskDeaktiver automatiske terminaltitteloppdateringer
OPENCODE_PERMISSIONstrengInnebygd json-tillatelseskonfigurasjon
OPENCODE_DISABLE_DEFAULT_PLUGINSboolskDeaktiver standard plugins
OPENCODE_DISABLE_LSP_DOWNLOADboolskDeaktiver automatiske LSP servernedlastinger
OPENCODE_ENABLE_EXPERIMENTAL_MODELSboolskAktiver eksperimentelle modeller
OPENCODE_DISABLE_AUTOCOMPACTboolskDeaktiver automatisk kontekstkomprimering
OPENCODE_DISABLE_CLAUDE_CODEboolskDeaktiver lesing fra .claude (spørsmål + ferdigheter)
OPENCODE_DISABLE_CLAUDE_CODE_PROMPTboolskDeaktiver lesing ~/.claude/CLAUDE.md
OPENCODE_DISABLE_CLAUDE_CODE_SKILLSboolskDeaktiver innlasting av .claude/skills
OPENCODE_DISABLE_MODELS_FETCHboolskDeaktiver henting av modeller fra eksterne kilder
OPENCODE_FAKE_VCSstrengFalsk VCS-leverandør for testformål
OPENCODE_CLIENTstrengKlientidentifikator (standard til cli)
OPENCODE_ENABLE_EXAboolskAktiver Exa-nettsøkeverktøy
OPENCODE_SERVER_PASSWORDstrengAktiver grunnleggende autentisering for serve/web
OPENCODE_SERVER_USERNAMEstrengOverstyr grunnleggende autentiseringsbrukernavn (standard opencode)
OPENCODE_MODELS_URLstrengEgendefinert URL for henting av modellkonfigurasjon

Disse miljøvariablene muliggjør eksperimentelle funksjoner som kan endres eller fjernes.

VariabelTypeBeskrivelse
OPENCODE_EXPERIMENTALboolskAktiver eksperimentelle funksjoner under samleflagget
OPENCODE_EXPERIMENTAL_ICON_DISCOVERYboolskAktiver ikonoppdagelse
OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECTboolskDeaktiver kopi ved valg i TUI
OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MStallStandard tidsavbrudd for bash-kommandoer i ms
OPENCODE_EXPERIMENTAL_OUTPUT_TOKEN_MAXtallMaks Output Tokens for LLM-svar
OPENCODE_EXPERIMENTAL_FILEWATCHERboolskAktiver filovervåker for hele dir
OPENCODE_EXPERIMENTAL_OXFMTboolskAktiver oxfmt formatter
OPENCODE_EXPERIMENTAL_LSP_TOOLboolskAktiver eksperimentelt LSP-verktøy
OPENCODE_EXPERIMENTAL_DISABLE_FILEWATCHERboolskDeaktiver filovervåking
OPENCODE_EXPERIMENTAL_EXAboolskAktiver eksperimentelle Exa-funksjoner
OPENCODE_EXPERIMENTAL_LSP_TYboolskAktiver TY LSP for python-filer
OPENCODE_EXPERIMENTAL_PLAN_MODEboolskAktiver planmodus
OPENCODE_EXPERIMENTAL_EVENT_SYSTEMboolskAktiver eksperimentelt hendelsessystem
OPENCODE_EXPERIMENTAL_NATIVE_LLMboolskAktiver innebygd LLM-forespørselsvei
OPENCODE_EXPERIMENTAL_PARALLELboolskAktiver parallell kjøring av websøk
OPENCODE_EXPERIMENTAL_SCOUTboolskAktiver Scout-subagent
OPENCODE_EXPERIMENTAL_WORKSPACESboolskAktiver arbeidsområde-støtte