Skip to main content

styrminctl CLI

styrminctl CLI​

Stub page — to be auto-generated

This page will be generated from the Cyclopts command tree at build time. The information below is a placeholder describing scope, not the final content.

Until the auto-generation pipeline is wired up, the authoritative source is the CLI itself:

styrminctl --help
styrminctl <command> --help

Plus the source tree under cli/.

Scope​

styrminctl is the Cyclopts-based command-line client for Styrmin. It's a thin wrapper over the GraphQL API — it never talks to the database or the agent directly.

This page will document, command by command:

  • Top-level commands (cluster, environment, deployment, driver, backup, restore, upgrade, auth, ...)
  • Sub-commands and their flags
  • Output formats (--output text|json|yaml)
  • Exit codes
  • Authentication and configuration (where the CLI looks for a server URL and a token)

Auto-generation source​

  • Schema: the Cyclopts command tree in cli/src/
  • Build step: TBD — walk the Cyclopts tree, emit one Markdown section per command, write it into this file