CLI
ArmIn CLI-alternativer og kommandoer.
ArmIn CLI starter som standard TUI når den kjøres uten noen argumenter.
arminMen den godtar også kommandoer som dokumentert på denne siden. Dette lar deg samhandle med ArmIn programmatisk.
armin run "Explain how closures work in JavaScript"tui
Start ArmIn-terminalbrukergrensesnittet.
armin [project]Flagg
| Flagg | Kort | Beskrivelse |
|---|---|---|
--continue | -c | Fortsett siste økt |
--session | -s | Økt ID for å fortsette |
--fork | Forgren økten ved fortsettelse (bruk med --continue eller --session) | |
--prompt | Ledetekst som skal brukes | |
--model | -m | Modell å bruke i form av leverandør/modell |
--agent | Agent som skal brukes | |
--port | Port å lytte på | |
--hostname | Vertsnavn å lytte på |
Kommandoer
ArmIn CLI har også følgende kommandoer.
agent
Administrer agenter for ArmIn.
armin agent [command]attach
Koble en terminal til en allerede kjørende ArmIn-backend-server startet via serve eller web kommandoer.
armin attach [url]Dette gjør det mulig å bruke TUI med en ekstern ArmIn-backend. For eksempel:
# Start the backend server for web/mobile accessarmin web --port 4096 --hostname 0.0.0.0
# In another terminal, attach the TUI to the running backendarmin attach http://10.20.30.40:4096Flagg
| Flagg | Kort | Beskrivelse |
|---|---|---|
--dir | Arbeidskatalog for å starte TUI i | |
--session | -s | Økt ID for å fortsette |
create
Opprett en ny agent med tilpasset konfigurasjon.
armin agent createDenne kommandoen vil veilede deg gjennom å lage en ny agent med en tilpasset systemmelding og verktøykonfigurasjon.
list
List opp alle tilgjengelige agenter.
armin agent listauth
Kommando for administrasjon av påloggingsinformasjon og innlogging for leverandører.
armin auth [command]login
ArmIn drives av leverandørlisten på Models.dev, så du kan bruke armin auth login til å konfigurere API-nøkler for enhver leverandør du vil bruke. Dette er lagret i ~/.local/share/armin/auth.json.
armin auth loginNår ArmIn 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.
armin auth listEller bruk kortversjonen.
armin auth lslogout
Logger deg ut av en leverandør ved å fjerne den fra filen med påloggingsinformasjon.
armin auth logoutgithub
Administrer GitHub-agenten for depotautomatisering.
armin github [command]install
Installer GitHub-agenten i depotet ditt.
armin github installDette 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.
armin github runFlagg
| Flagg | Beskrivelse |
|---|---|
--event | GitHub mock-hendelse agenten skal kjøres for |
--token | GitHub personlig tilgangsnøkkel |
mcp
Administrer Model Context Protocol-servere.
armin mcp [command]add
Legg til en MCP-server til konfigurasjonen.
armin mcp addDenne kommandoen vil veilede deg gjennom å legge til enten en lokal eller ekstern MCP-server.
list
Liste alle konfigurerte MCP-servere og deres tilkoblingsstatus.
armin mcp listEller bruk den korte versjonen.
armin mcp lsauth
Autentiser med en OAuth-aktivert MCP-server.
armin 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.
armin mcp auth listEller bruk den korte versjonen.
armin mcp auth lslogout
Fjern OAuth-påloggingsinformasjon for en MCP-server.
armin mcp logout [name]debug
Feilsøk OAuth-tilkoblingsproblemer for en MCP-server.
armin mcp debug <name>models
List opp alle tilgjengelige modeller fra konfigurerte leverandører.
armin 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.
armin models anthropicFlagg
| Flagg | Beskrivelse |
|---|---|
--refresh | Oppdater modellbufferen fra models.dev |
--verbose | 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 ArmIn.
armin models --refreshrun
Kjør ArmIn i ikke-interaktiv modus ved å sende en melding direkte.
armin run [message..]Dette er nyttig for skripting, automatisering eller når du vil ha et raskt svar uten å starte hele TUI. For eksempel.
armin run Explain the use of context in GoDu kan også koble til en kjørende armin serve-forekomst for å unngå MCP-serveres kaldstarttid ved hver kjøring:
# Start a headless server in one terminalarmin serve
# In another terminal, run commands that attach to itarmin run --attach http://localhost:4096 "Explain async/await in JavaScript"Flagg
| Flagg | Kort | Beskrivelse |
|---|---|---|
--command | Kommandoen for å kjøre, bruk melding for args | |
--continue | -c | Fortsett siste økt |
--session | -s | Økt ID for å fortsette |
--fork | Forgren økten ved fortsettelse (bruk med --continue eller --session) | |
--share | Del økten | |
--model | -m | Modell å bruke i form av leverandør/modell |
--agent | Agent å bruke | |
--file | -f | Fil(er) som skal legges ved meldingen |
--format | Format: standard (formatert) eller json (rå JSON hendelser) | |
--title | Tittel for økten (bruker avkortet ledetekst hvis ingen verdi er oppgitt) | |
--attach | Koble til en kjørende ArmIn-server (f.eks. http://localhost:4096) | |
--port | Port for den lokale serveren (standard til tilfeldig port) |
serve
Start en headless ArmIn-server for API-tilgang. Sjekk ut server-dokumentene for hele HTTP-grensesnittet.
armin serveDette starter en HTTP-server som gir API tilgang til ArmIn-funksjonalitet uten TUI-grensesnittet. Sett OPENCODE_SERVER_PASSWORD for å aktivere HTTP grunnleggende autentisering (brukernavn er standard til armin).
Flagg
| Flagg | Beskrivelse |
|---|---|
--port | Port å lytte på |
--hostname | Vertsnavn å lytte på |
--mdns | Aktiver mDNS-oppdagelse |
--cors | Ytterligere nettleseropprinnelse som tillater CORS |
session
Administrer ArmIn-økter.
armin session [command]list
List opp alle ArmIn-økter.
armin session listFlagg
| Flagg | Kort | Beskrivelse |
|---|---|---|
--max-count | -n | Begrens til N siste økter |
--format | Utdataformat: tabell eller json (tabell) |
stats
Vis tokenbruk og kostnadsstatistikk for ArmIn-øktene dine.
armin statsFlagg
| Flagg | Beskrivelse |
|---|---|
--days | Vis statistikk for de siste N dagene (hele tiden) |
--tools | Antall verktøy som skal vises (alle) |
--models | Vis oversikt over modellbruk (skjult som standard). Gi et tall for å vise topp N |
--project | Filtrer etter prosjekt (alle prosjekter, tom streng: gjeldende prosjekt) |
export
Eksporter øktdata som JSON.
armin 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 ArmIn share-URL.
armin import <file>Du kan importere fra en lokal fil eller en ArmIn share-URL.
armin import session.jsonarmin import https://opncd.ai/s/abc123web
Start en headless ArmIn-server med et webgrensesnitt.
armin webDette starter en HTTP-server og åpner en nettleser for å få tilgang til ArmIn via et nettgrensesnitt. Sett OPENCODE_SERVER_PASSWORD for å aktivere HTTP grunnleggende autentisering (brukernavn er standard til armin).
Flagg
| Flagg | Beskrivelse |
|---|---|
--port | Port å lytte på |
--hostname | Vertsnavn å lytte på |
--mdns | Aktiver mDNS-oppdagelse |
--cors | Ytterligere nettleseropprinnelse som tillater CORS |
acp
Start en ACP (Agent Client Protocol) server.
armin acpDenne kommandoen starter en ACP-server som kommuniserer via stdin/stdout ved å bruke nd-JSON.
Flagg
| Flagg | Beskrivelse |
|---|---|
--cwd | Arbeidskatalog |
--port | Port å lytte på |
--hostname | Vertsnavn å lytte på |
uninstall
Avinstaller ArmIn og fjern alle relaterte filer.
armin uninstallFlagg
| Flagg | Kort | Beskrivelse |
|---|---|---|
--keep-config | -c | Behold konfigurasjonsfiler |
--keep-data | -d | Behold øktdata og øyeblikksbilder |
--dry-run | Vis hva som ville blitt fjernet uten å fjerne | |
--force | -f | Hopp over bekreftelsesforespørsler |
upgrade
Oppdaterer ArmIn til siste versjon eller en spesifikk versjon.
armin upgrade [target]For å oppgradere til siste versjon.
armin upgradeFor å oppgradere til en bestemt versjon.
armin upgrade v0.1.48Flagg
| Flagg | Kort | Beskrivelse |
|---|---|---|
--method | -m | Installasjonsmetoden som ble brukt: curl, npm, pnpm, bun, brew |
Globale flagg
ArmIn CLI bruker følgende globale flagg.
| Flagg | Kort | Beskrivelse |
|---|---|---|
--help | -h | Vis hjelp |
--version | -v | Skriv ut versjonsnummer |
--print-logs | Skriv ut logger til stderr | |
--log-level | Loggnivå (DEBUG, INFO, WARN, ERROR) |
Miljøvariabler
ArmIn 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_DISABLE_FILETIME_CHECK | boolsk | Deaktiver filtidskontroll for optimalisering |
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 armin) |
OPENCODE_MODELS_URL | streng | Egendefinert URL for henting av modellkonfigurasjon |
Eksperimentelt
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 |