Gå til indhold

CLI

CodeTutor CLI starter som standard TUI, når den kører uden nogen argumenter.

Terminal window
opencode

Men den accepterer også kommandoer som dokumenteret på denne side. Dette giver dig mulighed for at interagere med CodeTutor programmatisk.

Terminal window
codetutor run "Explain how closures work in JavaScript"

tui

Start CodeTutor terminalbrugergrænsefladen.

Terminal window
opencode [project]

Flag

FlagKortBeskrivelse
--continue-cFortsæt sidste session
--session-sSessions-id for at fortsætte
--forkForgren sessionen ved fortsættelse (brug med --continue eller --session)
--promptSpørg om at bruge
--model-mModel til brug i form af provider/model
--agentAgent hos bruge
--portPort at lytte på
--hostnameVærtsnavn at lytte på

Kommandoer

CodeTutor CLI har også følgende kommandoer.


agent

Administrer agenter i CodeTutor.

Terminal window
codetutor agent [command]

attach

Tilslut en terminal til en allerede kørende CodeTutor backend-server startet via serve eller web kommandoer.

Terminal window
codetutor attach [url]

Dette gør det muligt at bruge TUI med en ekstern CodeTutor backend. For eksempel:

Terminal window
# Start the backend server for web/mobile access
codetutor web --port 4096 --hostname 0.0.0.0
# In another terminal, attach the TUI to the running backend
codetutor attach http://10.20.30.40:4096

Flag

FlagKortBeskrivelse
--dirArbejdsmappe til at starte TUI i
--continue-cFortsæt den seneste session
--session-sSessions-id for at fortsætte
--forkForgren sessionen ved fortsættelse (brug med --continue eller --session)
--password-pAdgangskode til basic auth (standard: CODETUTOR_SERVER_PASSWORD)
--username-uBrugernavn til basic auth (standard: CODETUTOR_SERVER_USERNAME eller codetutor)

create

Opret en ny agent med brugerdefineret konfiguration.

Terminal window
codetutor agent create

Denne kommando vil guide dig gennem oprettelse af en ny agent med en brugerdefineret systemprompt og værktøjskonfiguration.


list

Liste over alle tilgængelige agenter.

Terminal window
codetutor agent list

auth

Kommando til at administrere legitimationsoplysninger og login for udbydere.

Terminal window
codetutor auth [command]

login

CodeTutor drives af udbyderlisten på Models.dev, så du kan bruge codetutor auth login til at konfigurere API-nøgler for enhver udbyder, du vil bruge. Dette er gemt i ~/.local/share/opencode/auth.json.

Terminal window
codetutor auth login

Når CodeTutor starter op, indlæser den udbyderne fra legitimationsfilen. Og hvis der er nogen nøgler defineret i dine miljøer eller en .env fil i dit projekt.


list

Viser alle de godkendte udbydere som gemt i legitimationsfilen.

Terminal window
codetutor auth list

Eller den korte version.

Terminal window
codetutor auth ls

logout

Logger dig ud af en udbyder ved at rydde den fra legitimationsfilen.

Terminal window
codetutor auth logout

github

Administrator GitHub-agenten til lagerautomatisering.

Terminal window
codetutor github [command]

install

Installatør GitHub-agenten i dit lager.

Terminal window
codetutor github install

Dette opsætter det nødvendige GitHub Actions workflow og guider dig gennem konfigurationsprocessen. Learn more.


run

Kør GitHub-agenten. Dette bruges typisk i GitHub Actions.

Terminal window
codetutor github run
Flag
FlagBeskrivelse
--eventGitHub mock begivenhed for at køre agenten for
--tokenGitHub personlig adgangstoken

mcp

Administrator Model Context Protocol-servere.

Terminal window
codetutor mcp [command]

add

Tilføj en MCP-server til din konfiguration.

Terminal window
codetutor mcp add

Denne kommando vil guide dig gennem tilføjelse af enten en lokal eller ekstern MCP-server.


list

Liste over alle konfigurerede MCP-servere og deres forbindelsesstatus.

Terminal window
codetutor mcp list

Eller brug den korte version.

Terminal window
codetutor mcp ls

auth

Godkendt med en OAuth-aktiveret MCP-server.

Terminal window
codetutor mcp auth [name]

Hvis du ikke angiver et servernavn, bliver du bedt om at vælge blandt tilgængelige OAuth-kompatible servere.

Du kan også angive OAuth-kompatible servere og deres godkendelsesstatus.

Terminal window
codetutor mcp auth list

Eller brug den korte version.

Terminal window
codetutor mcp auth ls

logout

Fjern OAuth-legitimationsoplysninger for en MCP-server.

Terminal window
codetutor mcp logout [name]

debug

Fejlfinding af OAuth-forbindelsesproblemer for en MCP-server.

Terminal window
codetutor mcp debug <name>

models

Liste over alle tilgængelige modeller fra konfigurerede udbydere.

Terminal window
codetutor models [provider]

Denne kommando viser alle tilgængelige modeller på tværs af dine konfigurerede udbydere i formatet provider/model.

Dette er nyttigt til at finde ud af det nøjagtige modelnavn, der skal bruges i your config.

Du kan eventuelt videregive et udbyder-id for at filtrere modeller efter den udbyder.

Terminal window
codetutor models anthropic

Flag

FlagBeskrivelse
--refreshOpdater modelcachen fra models.dev
--verboseBrug mere detaljeret modeloutput (inkluderer metadata som omkostninger)

Brug flaget --refresh til at opdatere den cachelagrede modelliste. Dette er nyttigt, når nye modeller er blevet tilføjet til en udbyder, og du vil se dem i CodeTutor.

Terminal window
codetutor models --refresh

run

Kør codetutor i ikke-interaktiv tilstand ved at sende en prompt direkte.

Terminal window
codetutor run [message..]

Dette er nyttigt til scripting, automatisering, eller når du vil have et hurtigt svar uden at starte hele TUI. F.eks.

Terminal window
codetutor run Explain the use of context in Go

Du kan også vedhæfte til en kørende codetutor serve-instans for at undgå MCP serverens kolde opstartstider ved hver kørsel:

Terminal window
# Start a headless server in one terminal
codetutor serve
# In another terminal, run commands that attach to it
codetutor run --attach http://localhost:4096 "Explain async/await in JavaScript"

Flag

FlagKortBeskrivelse
--commandKommandoen til at køre, brug besked til args
--continue-cFortsæt sidste session
--session-sSessions-id for at fortsætte
--forkForgren sessionen ved fortsættelse (brug med --continue eller --session)
--shareDel sessionen
--model-mModel til brug i form af provider/model
--agentAgent til brug
--file-fFil(er), der skal vedhæftes til meddelelsen
--formatFormat: standard (formateret) eller json (rå JSON hændelser)
--titleTitel for sessionen (bruger trunkeret prompt, hvis der ikke er angivet nogen værdi)
--attachTilslut til en kørende opencode-server (f.eks. http://localhost:4096)
--password-pAdgangskode til basic auth (standard: CODETUTOR_SERVER_PASSWORD)
--username-uBrugernavn til basic auth (standard: CODETUTOR_SERVER_USERNAME eller codetutor)
--dirMappe at køre i, eller sti på fjernserveren ved tilkobling
--variantModelvariant (udbyder-specifik ræsonneringsindsats)
--thinkingVis tænkeblokke
--portPort til den lokale server (standard til vilkårlig port)

serve

Start en hovedløs CodeTutor-server til API-adgang. Tjek server docs for den fulde HTTP-grænseflade.

Terminal window
codetutor serve

Dette starter en HTTP-server, der giver API-adgang til opencode-funktionalitet uden TUI-grænsefladen. Indstil CODETUTOR_SERVER_PASSWORD for at aktivere HTTP grundlæggende godkendelse (brugernavn er standard til codetutor).

Flag

FlagBeskrivelse
--portPort at lytte på
--hostnameVærtsnavn at lytte på
--mdnsAktiver mDNS-opdagelse
--corsYderligere browseroprindelse til at tillade CORS

session

Administrator CodeTutor sessionsholder.

Terminal window
codetutor session [command]

list

Liste over alle CodeTutor sessioner.

Terminal window
codetutor session list
Flag
FlagKortBeskrivelse
--max-count-nBegræns til N seneste sessioner
--formatOutputformat: tabel eller json (tabel)

stats

Vis tokenbrug og omkostningsstatistikker for dine CodeTutor-sessioner.

Terminal window
codetutor stats

Flag

FlagBeskrivelse
--daysVis statistik for de sidste N dage (hele tiden)
--toolsAntal værktøjer, der skal vises (alle)
--modelsVis modelbrugsopdeling (skjult som standard). Send et tal for at vise top N
--projectFiltre efter projekt (alle projekter, tom streng: nuværende projekt)

export

Eksporter sessionsdata som JSON.

Terminal window
codetutor export [sessionID]

Hvis du ikke angiver et sessions-id, bliver du bedt om at vælge mellem tilgængelige sessioner.


import

Importer sessionsdata fra en JSON fil eller CodeTutor del URL.

Terminal window
codetutor import <file>

Du kan importere fra en lokal fil eller en CodeTutor share URL.

Terminal window
codetutor import session.json
codetutor import https://opncd.ai/s/abc123

web

Start en hovedløs CodeTutor-server med en webgrænseflade.

Terminal window
codetutor web

Dette starter en HTTP-server og åbner en webbrowser for at få adgang til CodeTutor via en webgrænseflade. Indstil CODETUTOR_SERVER_PASSWORD for at aktivere HTTP grundlæggende godkendelse (brugernavn er standard til codetutor).

Flag

FlagBeskrivelse
--portPort at lytte på
--hostnameVærtsnavn at lytte på
--mdnsAktiver mDNS-opdagelse
--corsYderligere browseroprindelse til at tillade CORS

acp

Start en ACP-server (Agent Client Protocol).

Terminal window
codetutor acp

Denne kommando starter en ACP-server, der kommunikerer via stdin/stdout ved hjælp af nd-JSON.

Flag

FlagBeskrivelse
--cwdArbejdsmappe
--portPort at lytte på
--hostnameVærtsnavn at lytte på

uninstall

Afinstaller CodeTutor og fjern alle relaterede filer.

Terminal window
codetutor uninstall

Flag

FlagKortBeskrivelse
--keep-config-cSe konfigurationsfiler
--keep-data-dGem sessionsdata og snapshots
--dry-runVis, hvad der ville blive fjernet uden at fjerne
--force-fSpring bekræftelsesspørgsmål over

upgrade

Opdaterer CodeTutor til den nyeste version eller en specifik version.

Terminal window
codetutor upgrade [target]

For at opgradere til den nyeste version.

Terminal window
codetutor upgrade

For at opgradere til en bestemt version.

Terminal window
codetutor upgrade v0.1.48

upgrade

FlagKortBeskrivelse
--method-mInstallationsmetoden, der blev brugt; curl, npm, pnpm, bun, brew

Globale flag

opencode CLI tager følgende globale flag.

FlagKortBeskrivelse
--help-hVis hjælp
--version-vUdskriftsversionsnummer
--print-logsUdskriv logfiler til stderr
--log-levelLogniveau (DEBUG, INFO, WARN, ERROR)

Miljøvariabler

CodeTutor kan konfigureres ved hjælp af miljøvariabler.

VariabelSkrivBeskrivelse
CODETUTOR_AUTO_SHAREbooleanDel automatisk session
CODETUTOR_GIT_BASH_PATHstringSti til Git Bash eksekverbar på Windows
CODETUTOR_CONFIGstringSti til konfigurationsfil
CODETUTOR_TUI_CONFIGstringSti til TUI-konfigurationsfil
CODETUTOR_CONFIG_DIRstringSti til konfigurationsmappe
CODETUTOR_CONFIG_CONTENTstringIndbygget json-konfigurationsindhold
CODETUTOR_DISABLE_AUTOUPDATEbooleanDeaktiver automatisk opdateringskontrol
CODETUTOR_DISABLE_PRUNEbooleanDeaktiver beskæring af gamle data
CODETUTOR_DISABLE_TERMINAL_TITLEbooleanDeaktiver automatisk opdatering af terminaltitel
CODETUTOR_PERMISSIONstringIndbygget json-tilladelseskonfiguration
CODETUTOR_DISABLE_DEFAULT_PLUGINSbooleanDeaktiver standard plugins
CODETUTOR_DISABLE_LSP_DOWNLOADbooleanDeaktiver automatisk LSP-serverdownloads
CODETUTOR_ENABLE_EXPERIMENTAL_MODELSbooleanAktive eksperimentelle modeller
CODETUTOR_DISABLE_AUTOCOMPACTbooleanDeaktiver automatisk kontekstkomprimering
CODETUTOR_DISABLE_CLAUDE_CODEbooleanDeaktiver læsning fra .claude (prompt + færdigheder)
CODETUTOR_DISABLE_CLAUDE_CODE_PROMPTbooleanDeaktiver læsning ~/.claude/CLAUDE.md
CODETUTOR_DISABLE_CLAUDE_CODE_SKILLSbooleanDeaktiver indlæsning af .claude/skills
CODETUTOR_DISABLE_MODELS_FETCHbooleanDeaktivering af modeller fra eksterne kilder
CODETUTOR_FAKE_VCSstringFalsk VCS-udbyder til testformål
CODETUTOR_CLIENTstringKlient-id (standard til cli)
CODETUTOR_ENABLE_EXAbooleanAktiver Exa-websøgeværktøjer
CODETUTOR_SERVER_PASSWORDstringAktiver grundlæggende godkendelse for serve/web
CODETUTOR_SERVER_USERNAMEstringTilsidesæt grundlæggende godkendelsesbrugernavn (standard codetutor)
CODETUTOR_MODELS_URLstringBrugerdefineret URL til hentning af modelkonfiguration

Eksperimentel

Disse miljøvariabler muliggør eksperimentelle funktioner, der kan ændres eller fjernes.

VariabelSkrivBeskrivelse
CODETUTOR_EXPERIMENTALbooleanAktiver eksperimentelle funktioner under samleflaget
CODETUTOR_EXPERIMENTAL_ICON_DISCOVERYbooleanAktiver ikonopdagelse
CODETUTOR_EXPERIMENTAL_DISABLE_COPY_ON_SELECTbooleanDeaktiver kopi ved valg i TUI
CODETUTOR_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MSnummerStandard timeout for bash-kommandoer i ms
CODETUTOR_EXPERIMENTAL_OUTPUT_TOKEN_MAXnummerMaks. output-tokens for LLM-svar
CODETUTOR_EXPERIMENTAL_FILEWATCHERbooleanAktiver filovervågning for hele dir
CODETUTOR_EXPERIMENTAL_OXFMTbooleanAktiver oxfmt formatter
CODETUTOR_EXPERIMENTAL_LSP_TOOLbooleanAktive eksperimenter LSP værktøj
CODETUTOR_EXPERIMENTAL_DISABLE_FILEWATCHERbooleanDeaktiver filovervågning
CODETUTOR_EXPERIMENTAL_EXAbooleanAktive eksperimenter Exa-funktioner
CODETUTOR_EXPERIMENTAL_LSP_TYbooleanAktiver TY LSP for python-filer
CODETUTOR_EXPERIMENTAL_PLAN_MODEbooleanAktiver plantilstand
CODETUTOR_EXPERIMENTAL_BACKGROUND_SUBAGENTSbooleanAktiver baggrundsopgaver for subagenter
CODETUTOR_EXPERIMENTAL_EVENT_SYSTEMbooleanAktiver eksperimentelt hændelsessystem
CODETUTOR_EXPERIMENTAL_NATIVE_LLMbooleanAktiver native LLM-anmodningssti
CODETUTOR_EXPERIMENTAL_PARALLELbooleanAktiver parallel udførelse af websøgning
CODETUTOR_EXPERIMENTAL_SCOUTbooleanAktiver Scout-subagent
CODETUTOR_EXPERIMENTAL_WORKSPACESbooleanAktiver workspace-understøttelse