Gå til innholdet

CLI

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

Terminal window
opencode

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

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

tui

Start CodeTutor-terminalbrukergrensesnittet.

Terminal window
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å

Kommandoer

CodeTutor CLI har også følgende kommandoer.


agent

Administrer agenter for CodeTutor.

Terminal window
codetutor agent [command]

attach

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

Terminal window
codetutor attach [url]

Dette gjør det mulig å bruke 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

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: CODETUTOR_SERVER_PASSWORD)
--username-uBrukernavn for grunnleggende autentisering (standard: CODETUTOR_SERVER_USERNAME eller codetutor)

create

Opprett en ny agent med tilpasset konfigurasjon.

Terminal window
codetutor agent create

Denne kommandoen vil veilede deg gjennom å lage en ny agent med en tilpasset systemmelding og verktøykonfigurasjon.


list

List opp alle tilgjengelige agenter.

Terminal window
codetutor agent list

auth

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

Terminal window
codetutor auth [command]

login

CodeTutor drives av leverandørlisten på Models.dev, så du kan bruke codetutor auth login til å konfigurere API-nøkler for enhver leverandør du vil bruke. Dette er lagret i ~/.local/share/opencode/auth.json.

Terminal window
codetutor auth login

Når CodeTutor 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 window
codetutor auth list

Eller bruk kortversjonen.

Terminal window
codetutor auth ls

logout

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

Terminal window
codetutor auth logout

github

Administrer GitHub-agenten for depotautomatisering.

Terminal window
codetutor github [command]

install

Installer GitHub-agenten i depotet ditt.

Terminal window
codetutor 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 window
codetutor github run
Flagg
FlaggBeskrivelse
--eventGitHub mock-hendelse agenten skal kjøres for
--tokenGitHub personlig tilgangsnøkkel

mcp

Administrer Model Context Protocol-servere.

Terminal window
codetutor mcp [command]

add

Legg til en MCP-server til konfigurasjonen.

Terminal window
codetutor 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 window
codetutor mcp list

Eller bruk den korte versjonen.

Terminal window
codetutor mcp ls

auth

Autentiser med en OAuth-aktivert MCP-server.

Terminal window
codetutor 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 window
codetutor mcp auth list

Eller bruk den korte versjonen.

Terminal window
codetutor mcp auth ls

logout

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

Terminal window
codetutor mcp logout [name]

debug

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

Terminal window
codetutor mcp debug <name>

models

List opp alle tilgjengelige modeller fra konfigurerte leverandører.

Terminal window
codetutor 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 window
codetutor 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 CodeTutor.

Terminal window
codetutor models --refresh

run

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

Terminal window
codetutor run [message..]

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

Terminal window
codetutor run Explain the use of context in Go

Du kan også koble til en kjørende codetutor serve-forekomst for å unngå MCP-serveres kaldstarttid ved hver kjøring:

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"

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)
--shareDel økten
--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 CodeTutor-server (f.eks. http://localhost:4096)
--password-pPassord for grunnleggende autentisering (standard: CODETUTOR_SERVER_PASSWORD)
--username-uBrukernavn for grunnleggende autentisering (standard: CODETUTOR_SERVER_USERNAME eller codetutor)
--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)

serve

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

Terminal window
codetutor serve

Dette starter en HTTP-server som gir API tilgang til CodeTutor-funksjonalitet uten TUI-grensesnittet. Sett CODETUTOR_SERVER_PASSWORD for å aktivere HTTP grunnleggende autentisering (brukernavn er standard til codetutor).

Flagg

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

session

Administrer CodeTutor-økter.

Terminal window
codetutor session [command]

list

List opp alle CodeTutor-økter.

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

stats

Vis tokenbruk og kostnadsstatistikk for CodeTutor-øktene dine.

Terminal window
codetutor 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)

export

Eksporter øktdata som JSON.

Terminal window
codetutor export [sessionID]

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


import

Importer øktdata fra en JSON-fil eller en CodeTutor share-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 headless CodeTutor-server med et webgrensesnitt.

Terminal window
codetutor web

Dette starter en HTTP-server og åpner en nettleser for å få tilgang til CodeTutor via et nettgrensesnitt. Sett CODETUTOR_SERVER_PASSWORD for å aktivere HTTP grunnleggende autentisering (brukernavn er standard til codetutor).

Flagg

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

acp

Start en ACP (Agent Client Protocol) server.

Terminal window
codetutor 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å

uninstall

Avinstaller CodeTutor og fjern alle relaterte filer.

Terminal window
codetutor 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

upgrade

Oppdaterer CodeTutor til siste versjon eller en spesifikk versjon.

Terminal window
codetutor upgrade [target]

For å oppgradere til siste versjon.

Terminal window
codetutor upgrade

For å oppgradere til en bestemt versjon.

Terminal window
codetutor upgrade v0.1.48

Flagg

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

Globale flagg

CodeTutor 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)

Miljøvariabler

CodeTutor kan konfigureres ved hjelp av miljøvariabler.

VariabelTypeBeskrivelse
CODETUTOR_AUTO_SHAREboolskDel økter automatisk
CODETUTOR_GIT_BASH_PATHstrengBane til Git Bash-kjørbar på Windows
CODETUTOR_CONFIGstrengBane til konfigurasjonsfil
CODETUTOR_TUI_CONFIGstrengBane til TUI-konfigurasjonsfil
CODETUTOR_CONFIG_DIRstrengBane til konfigurasjonskatalog
CODETUTOR_CONFIG_CONTENTstrengInnebygd json-konfigurasjonsinnhold
CODETUTOR_DISABLE_AUTOUPDATEboolskDeaktiver automatiske oppdateringskontroller
CODETUTOR_DISABLE_PRUNEboolskDeaktiver beskjæring av gamle data
CODETUTOR_DISABLE_TERMINAL_TITLEboolskDeaktiver automatiske terminaltitteloppdateringer
CODETUTOR_PERMISSIONstrengInnebygd json-tillatelseskonfigurasjon
CODETUTOR_DISABLE_DEFAULT_PLUGINSboolskDeaktiver standard plugins
CODETUTOR_DISABLE_LSP_DOWNLOADboolskDeaktiver automatiske LSP servernedlastinger
CODETUTOR_ENABLE_EXPERIMENTAL_MODELSboolskAktiver eksperimentelle modeller
CODETUTOR_DISABLE_AUTOCOMPACTboolskDeaktiver automatisk kontekstkomprimering
CODETUTOR_DISABLE_CLAUDE_CODEboolskDeaktiver lesing fra .claude (spørsmål + ferdigheter)
CODETUTOR_DISABLE_CLAUDE_CODE_PROMPTboolskDeaktiver lesing ~/.claude/CLAUDE.md
CODETUTOR_DISABLE_CLAUDE_CODE_SKILLSboolskDeaktiver innlasting av .claude/skills
CODETUTOR_DISABLE_MODELS_FETCHboolskDeaktiver henting av modeller fra eksterne kilder
CODETUTOR_FAKE_VCSstrengFalsk VCS-leverandør for testformål
CODETUTOR_CLIENTstrengKlientidentifikator (standard til cli)
CODETUTOR_ENABLE_EXAboolskAktiver Exa-nettsøkeverktøy
CODETUTOR_SERVER_PASSWORDstrengAktiver grunnleggende autentisering for serve/web
CODETUTOR_SERVER_USERNAMEstrengOverstyr grunnleggende autentiseringsbrukernavn (standard codetutor)
CODETUTOR_MODELS_URLstrengEgendefinert URL for henting av modellkonfigurasjon

Eksperimentelt

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

VariabelTypeBeskrivelse
CODETUTOR_EXPERIMENTALboolskAktiver eksperimentelle funksjoner under samleflagget
CODETUTOR_EXPERIMENTAL_ICON_DISCOVERYboolskAktiver ikonoppdagelse
CODETUTOR_EXPERIMENTAL_DISABLE_COPY_ON_SELECTboolskDeaktiver kopi ved valg i TUI
CODETUTOR_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MStallStandard tidsavbrudd for bash-kommandoer i ms
CODETUTOR_EXPERIMENTAL_OUTPUT_TOKEN_MAXtallMaks Output Tokens for LLM-svar
CODETUTOR_EXPERIMENTAL_FILEWATCHERboolskAktiver filovervåker for hele dir
CODETUTOR_EXPERIMENTAL_OXFMTboolskAktiver oxfmt formatter
CODETUTOR_EXPERIMENTAL_LSP_TOOLboolskAktiver eksperimentelt LSP-verktøy
CODETUTOR_EXPERIMENTAL_DISABLE_FILEWATCHERboolskDeaktiver filovervåking
CODETUTOR_EXPERIMENTAL_EXAboolskAktiver eksperimentelle Exa-funksjoner
CODETUTOR_EXPERIMENTAL_LSP_TYboolskAktiver TY LSP for python-filer
CODETUTOR_EXPERIMENTAL_PLAN_MODEboolskAktiver planmodus
CODETUTOR_EXPERIMENTAL_BACKGROUND_SUBAGENTSboolskAktiver bakgrunnsoppgaver for subagenter
CODETUTOR_EXPERIMENTAL_EVENT_SYSTEMboolskAktiver eksperimentelt hendelsessystem
CODETUTOR_EXPERIMENTAL_NATIVE_LLMboolskAktiver innebygd LLM-forespørselsvei
CODETUTOR_EXPERIMENTAL_PARALLELboolskAktiver parallell kjøring av websøk
CODETUTOR_EXPERIMENTAL_SCOUTboolskAktiver Scout-subagent
CODETUTOR_EXPERIMENTAL_WORKSPACESboolskAktiver arbeidsområde-støtte