Gå til indhold

CLI

OpenSploit CLI muligheder og kommandoer.

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

Terminal window
opensploit

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

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

tui

Start OpenSploit terminalbrugergrænsefladen.

Terminal window
opensploit [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

OpenSploit CLI har også følgende kommandoer.


agent

Administrer agenter i OpenSploit.

Terminal window
opensploit agent [command]

attach

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

Terminal window
opensploit attach [url]

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

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

Flag

FlagKortBeskrivelse
--dirArbejdsmappe til at starte TUI i
--session-sSessions-id for at fortsætte

create

Opret en ny agent med brugerdefineret konfiguration.

Terminal window
opensploit 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
opensploit agent list

auth

Kommando til at administrere legitimationsoplysninger og login for udbydere.

Terminal window
opensploit auth [command]

login

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

Terminal window
opensploit auth login

Når OpenSploit 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
opensploit auth list

Eller den korte version.

Terminal window
opensploit auth ls

logout

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

Terminal window
opensploit auth logout

github

Administrator GitHub-agenten til lagerautomatisering.

Terminal window
opensploit github [command]

install

Installatør GitHub-agenten i dit lager.

Terminal window
opensploit 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
opensploit github run
Flag
FlagBeskrivelse
--eventGitHub mock begivenhed for at køre agenten for
--tokenGitHub personlig adgangstoken

mcp

Administrator Model Context Protocol-servere.

Terminal window
opensploit mcp [command]

add

Tilføj en MCP-server til din konfiguration.

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

Eller brug den korte version.

Terminal window
opensploit mcp ls

auth

Godkendt med en OAuth-aktiveret MCP-server.

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

Eller brug den korte version.

Terminal window
opensploit mcp auth ls

logout

Fjern OAuth-legitimationsoplysninger for en MCP-server.

Terminal window
opensploit mcp logout [name]

debug

Fejlfinding af OAuth-forbindelsesproblemer for en MCP-server.

Terminal window
opensploit mcp debug <name>

models

Liste over alle tilgængelige modeller fra konfigurerede udbydere.

Terminal window
opensploit 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
opensploit 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 OpenSploit.

Terminal window
opensploit models --refresh

run

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

Terminal window
opensploit 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
opensploit run Explain the use of context in Go

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

Terminal window
# Start a headless server in one terminal
opensploit serve
# In another terminal, run commands that attach to it
opensploit 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 opensploit-server (f.eks. http://localhost:4096)
--portPort til den lokale server (standard til vilkårlig port)

serve

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

Terminal window
opensploit serve

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

Flag

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

session

Administrator OpenSploit sessionsholder.

Terminal window
opensploit session [command]

list

Liste over alle OpenSploit sessioner.

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

stats

Vis tokenbrug og omkostningsstatistikker for dine OpenSploit-sessioner.

Terminal window
opensploit 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
opensploit 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 OpenSploit del URL.

Terminal window
opensploit import <file>

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

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

web

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

Terminal window
opensploit web

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

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
opensploit 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 OpenSploit og fjern alle relaterede filer.

Terminal window
opensploit 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 OpenSploit til den nyeste version eller en specifik version.

Terminal window
opensploit upgrade [target]

For at opgradere til den nyeste version.

Terminal window
opensploit upgrade

For at opgradere til en bestemt version.

Terminal window
opensploit upgrade v0.1.48

upgrade

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

Globale flag

opensploit 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

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

VariabelSkrivBeskrivelse
OPENCODE_AUTO_SHAREbooleanDel automatisk session
OPENCODE_GIT_BASH_PATHstringSti til Git Bash eksekverbar på Windows
OPENCODE_CONFIGstringSti til konfigurationsfil
OPENCODE_TUI_CONFIGstringSti til TUI-konfigurationsfil
OPENCODE_CONFIG_DIRstringSti til konfigurationsmappe
OPENCODE_CONFIG_CONTENTstringIndbygget json-konfigurationsindhold
OPENCODE_DISABLE_AUTOUPDATEbooleanDeaktiver automatisk opdateringskontrol
OPENCODE_DISABLE_PRUNEbooleanDeaktiver beskæring af gamle data
OPENCODE_DISABLE_TERMINAL_TITLEbooleanDeaktiver automatisk opdatering af terminaltitel
OPENCODE_PERMISSIONstringIndbygget json-tilladelseskonfiguration
OPENCODE_DISABLE_DEFAULT_PLUGINSbooleanDeaktiver standard plugins
OPENCODE_DISABLE_LSP_DOWNLOADbooleanDeaktiver automatisk LSP-serverdownloads
OPENCODE_ENABLE_EXPERIMENTAL_MODELSbooleanAktive eksperimentelle modeller
OPENCODE_DISABLE_AUTOCOMPACTbooleanDeaktiver automatisk kontekstkomprimering
OPENCODE_DISABLE_CLAUDE_CODEbooleanDeaktiver læsning fra .claude (prompt + færdigheder)
OPENCODE_DISABLE_CLAUDE_CODE_PROMPTbooleanDeaktiver læsning ~/.claude/CLAUDE.md
OPENCODE_DISABLE_CLAUDE_CODE_SKILLSbooleanDeaktiver indlæsning af .claude/skills
OPENCODE_DISABLE_MODELS_FETCHbooleanDeaktivering af modeller fra eksterne kilder
OPENCODE_FAKE_VCSstringFalsk VCS-udbyder til testformål
OPENCODE_DISABLE_FILETIME_CHECKbooleanDeaktiver filtidskontrol for optimering
OPENCODE_CLIENTstringKlient-id (standard til cli)
OPENCODE_ENABLE_EXAbooleanAktiver Exa-websøgeværktøjer
OPENCODE_SERVER_PASSWORDstringAktiver grundlæggende godkendelse for serve/web
OPENCODE_SERVER_USERNAMEstringTilsidesæt grundlæggende godkendelsesbrugernavn (standard opensploit)
OPENCODE_MODELS_URLstringBrugerdefineret URL til hentning af modelkonfiguration

Eksperimentel

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

VariabelSkrivBeskrivelse
OPENCODE_EXPERIMENTALbooleanAktiver alle eksperimentelle funktioner
OPENCODE_EXPERIMENTAL_ICON_DISCOVERYbooleanAktiver ikonopdagelse
OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECTbooleanDeaktiver kopi ved valg i TUI
OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MSnummerStandard timeout for bash-kommandoer i ms
OPENCODE_EXPERIMENTAL_OUTPUT_TOKEN_MAXnummerMaks. output-tokens for LLM-svar
OPENCODE_EXPERIMENTAL_FILEWATCHERbooleanAktiver filovervågning for hele dir
OPENCODE_EXPERIMENTAL_OXFMTbooleanAktiver oxfmt formatter
OPENCODE_EXPERIMENTAL_LSP_TOOLbooleanAktive eksperimenter LSP værktøj
OPENCODE_EXPERIMENTAL_DISABLE_FILEWATCHERbooleanDeaktiver filovervågning
OPENCODE_EXPERIMENTAL_EXAbooleanAktive eksperimenter Exa-funktioner
OPENCODE_EXPERIMENTAL_LSP_TYbooleanAktive forsøg LSP typekontrol
OPENCODE_EXPERIMENTAL_MARKDOWNbooleanAktive eksperimentelle markdown-funktioner
OPENCODE_EXPERIMENTAL_PLAN_MODEbooleanAktiver plantilstand