CLI
CodeTutor CLI starter som standard TUI, når den kører uden nogen argumenter.
opencodeMen den accepterer også kommandoer som dokumenteret på denne side. Dette giver dig mulighed for at interagere med CodeTutor programmatisk.
codetutor run "Explain how closures work in JavaScript"tui
Start CodeTutor terminalbrugergrænsefladen.
opencode [project]Flag
| Flag | Kort | Beskrivelse |
|---|---|---|
--continue | -c | Fortsæt sidste session |
--session | -s | Sessions-id for at fortsætte |
--fork | Forgren sessionen ved fortsættelse (brug med --continue eller --session) | |
--prompt | Spørg om at bruge | |
--model | -m | Model til brug i form af provider/model |
--agent | Agent hos bruge | |
--port | Port at lytte på | |
--hostname | Værtsnavn at lytte på |
Kommandoer
CodeTutor CLI har også følgende kommandoer.
agent
Administrer agenter i CodeTutor.
codetutor agent [command]attach
Tilslut en terminal til en allerede kørende CodeTutor backend-server startet via serve eller web kommandoer.
codetutor attach [url]Dette gør det muligt at bruge TUI med en ekstern CodeTutor backend. For eksempel:
# Start the backend server for web/mobile accesscodetutor web --port 4096 --hostname 0.0.0.0
# In another terminal, attach the TUI to the running backendcodetutor attach http://10.20.30.40:4096Flag
| Flag | Kort | Beskrivelse |
|---|---|---|
--dir | Arbejdsmappe til at starte TUI i | |
--continue | -c | Fortsæt den seneste session |
--session | -s | Sessions-id for at fortsætte |
--fork | Forgren sessionen ved fortsættelse (brug med --continue eller --session) | |
--password | -p | Adgangskode til basic auth (standard: CODETUTOR_SERVER_PASSWORD) |
--username | -u | Brugernavn til basic auth (standard: CODETUTOR_SERVER_USERNAME eller codetutor) |
create
Opret en ny agent med brugerdefineret konfiguration.
codetutor agent createDenne 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.
codetutor agent listauth
Kommando til at administrere legitimationsoplysninger og login for udbydere.
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.
codetutor auth loginNå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.
codetutor auth listEller den korte version.
codetutor auth lslogout
Logger dig ud af en udbyder ved at rydde den fra legitimationsfilen.
codetutor auth logoutgithub
Administrator GitHub-agenten til lagerautomatisering.
codetutor github [command]install
Installatør GitHub-agenten i dit lager.
codetutor github installDette 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.
codetutor github runFlag
| Flag | Beskrivelse |
|---|---|
--event | GitHub mock begivenhed for at køre agenten for |
--token | GitHub personlig adgangstoken |
mcp
Administrator Model Context Protocol-servere.
codetutor mcp [command]add
Tilføj en MCP-server til din konfiguration.
codetutor mcp addDenne 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.
codetutor mcp listEller brug den korte version.
codetutor mcp lsauth
Godkendt med en OAuth-aktiveret MCP-server.
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.
codetutor mcp auth listEller brug den korte version.
codetutor mcp auth lslogout
Fjern OAuth-legitimationsoplysninger for en MCP-server.
codetutor mcp logout [name]debug
Fejlfinding af OAuth-forbindelsesproblemer for en MCP-server.
codetutor mcp debug <name>models
Liste over alle tilgængelige modeller fra konfigurerede udbydere.
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.
codetutor models anthropicFlag
| Flag | Beskrivelse |
|---|---|
--refresh | Opdater modelcachen fra models.dev |
--verbose | Brug 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.
codetutor models --refreshrun
Kør codetutor i ikke-interaktiv tilstand ved at sende en prompt direkte.
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.
codetutor run Explain the use of context in GoDu kan også vedhæfte til en kørende codetutor serve-instans for at undgå MCP serverens kolde opstartstider ved hver kørsel:
# Start a headless server in one terminalcodetutor serve
# In another terminal, run commands that attach to itcodetutor run --attach http://localhost:4096 "Explain async/await in JavaScript"Flag
| Flag | Kort | Beskrivelse |
|---|---|---|
--command | Kommandoen til at køre, brug besked til args | |
--continue | -c | Fortsæt sidste session |
--session | -s | Sessions-id for at fortsætte |
--fork | Forgren sessionen ved fortsættelse (brug med --continue eller --session) | |
--share | Del sessionen | |
--model | -m | Model til brug i form af provider/model |
--agent | Agent til brug | |
--file | -f | Fil(er), der skal vedhæftes til meddelelsen |
--format | Format: standard (formateret) eller json (rå JSON hændelser) | |
--title | Titel for sessionen (bruger trunkeret prompt, hvis der ikke er angivet nogen værdi) | |
--attach | Tilslut til en kørende opencode-server (f.eks. http://localhost:4096) | |
--password | -p | Adgangskode til basic auth (standard: CODETUTOR_SERVER_PASSWORD) |
--username | -u | Brugernavn til basic auth (standard: CODETUTOR_SERVER_USERNAME eller codetutor) |
--dir | Mappe at køre i, eller sti på fjernserveren ved tilkobling | |
--variant | Modelvariant (udbyder-specifik ræsonneringsindsats) | |
--thinking | Vis tænkeblokke | |
--port | Port 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.
codetutor serveDette 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
| Flag | Beskrivelse |
|---|---|
--port | Port at lytte på |
--hostname | Værtsnavn at lytte på |
--mdns | Aktiver mDNS-opdagelse |
--cors | Yderligere browseroprindelse til at tillade CORS |
session
Administrator CodeTutor sessionsholder.
codetutor session [command]list
Liste over alle CodeTutor sessioner.
codetutor session listFlag
| Flag | Kort | Beskrivelse |
|---|---|---|
--max-count | -n | Begræns til N seneste sessioner |
--format | Outputformat: tabel eller json (tabel) |
stats
Vis tokenbrug og omkostningsstatistikker for dine CodeTutor-sessioner.
codetutor statsFlag
| Flag | Beskrivelse |
|---|---|
--days | Vis statistik for de sidste N dage (hele tiden) |
--tools | Antal værktøjer, der skal vises (alle) |
--models | Vis modelbrugsopdeling (skjult som standard). Send et tal for at vise top N |
--project | Filtre efter projekt (alle projekter, tom streng: nuværende projekt) |
export
Eksporter sessionsdata som JSON.
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.
codetutor import <file>Du kan importere fra en lokal fil eller en CodeTutor share URL.
codetutor import session.jsoncodetutor import https://opncd.ai/s/abc123web
Start en hovedløs CodeTutor-server med en webgrænseflade.
codetutor webDette 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
| Flag | Beskrivelse |
|---|---|
--port | Port at lytte på |
--hostname | Værtsnavn at lytte på |
--mdns | Aktiver mDNS-opdagelse |
--cors | Yderligere browseroprindelse til at tillade CORS |
acp
Start en ACP-server (Agent Client Protocol).
codetutor acpDenne kommando starter en ACP-server, der kommunikerer via stdin/stdout ved hjælp af nd-JSON.
Flag
| Flag | Beskrivelse |
|---|---|
--cwd | Arbejdsmappe |
--port | Port at lytte på |
--hostname | Værtsnavn at lytte på |
uninstall
Afinstaller CodeTutor og fjern alle relaterede filer.
codetutor uninstallFlag
| Flag | Kort | Beskrivelse |
|---|---|---|
--keep-config | -c | Se konfigurationsfiler |
--keep-data | -d | Gem sessionsdata og snapshots |
--dry-run | Vis, hvad der ville blive fjernet uden at fjerne | |
--force | -f | Spring bekræftelsesspørgsmål over |
upgrade
Opdaterer CodeTutor til den nyeste version eller en specifik version.
codetutor upgrade [target]For at opgradere til den nyeste version.
codetutor upgradeFor at opgradere til en bestemt version.
codetutor upgrade v0.1.48upgrade
| Flag | Kort | Beskrivelse |
|---|---|---|
--method | -m | Installationsmetoden, der blev brugt; curl, npm, pnpm, bun, brew |
Globale flag
opencode CLI tager følgende globale flag.
| Flag | Kort | Beskrivelse |
|---|---|---|
--help | -h | Vis hjælp |
--version | -v | Udskriftsversionsnummer |
--print-logs | Udskriv logfiler til stderr | |
--log-level | Logniveau (DEBUG, INFO, WARN, ERROR) |
Miljøvariabler
CodeTutor kan konfigureres ved hjælp af miljøvariabler.
| Variabel | Skriv | Beskrivelse |
|---|---|---|
CODETUTOR_AUTO_SHARE | boolean | Del automatisk session |
CODETUTOR_GIT_BASH_PATH | string | Sti til Git Bash eksekverbar på Windows |
CODETUTOR_CONFIG | string | Sti til konfigurationsfil |
CODETUTOR_TUI_CONFIG | string | Sti til TUI-konfigurationsfil |
CODETUTOR_CONFIG_DIR | string | Sti til konfigurationsmappe |
CODETUTOR_CONFIG_CONTENT | string | Indbygget json-konfigurationsindhold |
CODETUTOR_DISABLE_AUTOUPDATE | boolean | Deaktiver automatisk opdateringskontrol |
CODETUTOR_DISABLE_PRUNE | boolean | Deaktiver beskæring af gamle data |
CODETUTOR_DISABLE_TERMINAL_TITLE | boolean | Deaktiver automatisk opdatering af terminaltitel |
CODETUTOR_PERMISSION | string | Indbygget json-tilladelseskonfiguration |
CODETUTOR_DISABLE_DEFAULT_PLUGINS | boolean | Deaktiver standard plugins |
CODETUTOR_DISABLE_LSP_DOWNLOAD | boolean | Deaktiver automatisk LSP-serverdownloads |
CODETUTOR_ENABLE_EXPERIMENTAL_MODELS | boolean | Aktive eksperimentelle modeller |
CODETUTOR_DISABLE_AUTOCOMPACT | boolean | Deaktiver automatisk kontekstkomprimering |
CODETUTOR_DISABLE_CLAUDE_CODE | boolean | Deaktiver læsning fra .claude (prompt + færdigheder) |
CODETUTOR_DISABLE_CLAUDE_CODE_PROMPT | boolean | Deaktiver læsning ~/.claude/CLAUDE.md |
CODETUTOR_DISABLE_CLAUDE_CODE_SKILLS | boolean | Deaktiver indlæsning af .claude/skills |
CODETUTOR_DISABLE_MODELS_FETCH | boolean | Deaktivering af modeller fra eksterne kilder |
CODETUTOR_FAKE_VCS | string | Falsk VCS-udbyder til testformål |
CODETUTOR_CLIENT | string | Klient-id (standard til cli) |
CODETUTOR_ENABLE_EXA | boolean | Aktiver Exa-websøgeværktøjer |
CODETUTOR_SERVER_PASSWORD | string | Aktiver grundlæggende godkendelse for serve/web |
CODETUTOR_SERVER_USERNAME | string | Tilsidesæt grundlæggende godkendelsesbrugernavn (standard codetutor) |
CODETUTOR_MODELS_URL | string | Brugerdefineret URL til hentning af modelkonfiguration |
Eksperimentel
Disse miljøvariabler muliggør eksperimentelle funktioner, der kan ændres eller fjernes.
| Variabel | Skriv | Beskrivelse |
|---|---|---|
CODETUTOR_EXPERIMENTAL | boolean | Aktiver eksperimentelle funktioner under samleflaget |
CODETUTOR_EXPERIMENTAL_ICON_DISCOVERY | boolean | Aktiver ikonopdagelse |
CODETUTOR_EXPERIMENTAL_DISABLE_COPY_ON_SELECT | boolean | Deaktiver kopi ved valg i TUI |
CODETUTOR_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS | nummer | Standard timeout for bash-kommandoer i ms |
CODETUTOR_EXPERIMENTAL_OUTPUT_TOKEN_MAX | nummer | Maks. output-tokens for LLM-svar |
CODETUTOR_EXPERIMENTAL_FILEWATCHER | boolean | Aktiver filovervågning for hele dir |
CODETUTOR_EXPERIMENTAL_OXFMT | boolean | Aktiver oxfmt formatter |
CODETUTOR_EXPERIMENTAL_LSP_TOOL | boolean | Aktive eksperimenter LSP værktøj |
CODETUTOR_EXPERIMENTAL_DISABLE_FILEWATCHER | boolean | Deaktiver filovervågning |
CODETUTOR_EXPERIMENTAL_EXA | boolean | Aktive eksperimenter Exa-funktioner |
CODETUTOR_EXPERIMENTAL_LSP_TY | boolean | Aktiver TY LSP for python-filer |
CODETUTOR_EXPERIMENTAL_PLAN_MODE | boolean | Aktiver plantilstand |
CODETUTOR_EXPERIMENTAL_BACKGROUND_SUBAGENTS | boolean | Aktiver baggrundsopgaver for subagenter |
CODETUTOR_EXPERIMENTAL_EVENT_SYSTEM | boolean | Aktiver eksperimentelt hændelsessystem |
CODETUTOR_EXPERIMENTAL_NATIVE_LLM | boolean | Aktiver native LLM-anmodningssti |
CODETUTOR_EXPERIMENTAL_PARALLEL | boolean | Aktiver parallel udførelse af websøgning |
CODETUTOR_EXPERIMENTAL_SCOUT | boolean | Aktiver Scout-subagent |
CODETUTOR_EXPERIMENTAL_WORKSPACES | boolean | Aktiver workspace-understøttelse |