Skip to content

cli.md

Latest commit

 

History

History
39 lines (34 loc) · 1.08 KB

cli.md

File metadata and controls

39 lines (34 loc) · 1.08 KB

CLI

The CLI is implemented with Commander in sources/main.ts. It always initializes logging first.

Commands

  • start - launches the engine (default settings .scout/settings.json).
  • status - prints engine status if the socket is live.
  • add - interactive setup for a provider or plugin.
  • plugins load <pluginId> [instanceId] - loads a plugin instance (updates settings if engine is down).
  • plugins unload <instanceId> - unloads a plugin instance.
  • auth set <id> <key> <value> - stores an auth credential.

Development

  • yarn dev runs the CLI directly via tsx.
flowchart TD
  main[main.ts] --> start[start]
  main --> status[status]
  main --> add[add]
  main --> plugins[plugins]
  main --> auth[auth]
Loading

start command flow

sequenceDiagram
  participant User
  participant CLI
  participant Settings
  participant Auth
  participant Plugins
  participant Engine
  User->>CLI: gram start
  CLI->>Settings: read .scout/settings.json
  CLI->>Auth: read .scout/auth.json
  CLI->>Plugins: load enabled plugins
  CLI->>Engine: start local socket + SSE
Loading