Skip to main content

CLI overview

This page gives a practical map of the Ogoron CLI: what each command group does and what it is typically used for.

Authentication and access​

  • OGORON_REPO_TOKEN — repository access token for your organization
  • OGORON_KEY — legacy alias for the same repository token
  • OGORON_LLM_API_KEY — user-provided OpenAI API key for BYOK trial access
  • OPENAI_API_KEY — fallback alias for the same BYOK key

The repository token is issued in the personal cabinet of the organization owner or another authorized organization member:

Command groups​

  • ogoron init — initialize and validate an Ogoron workspace
  • ogoron analyze — build project understanding used by generation and reporting
  • ogoron generate — generate test cases, tests, and supporting artifacts
  • ogoron heal — run tests and produce a failure-focused heal report (and apply human verdicts when needed)
  • ogoron run — run tests (when you want a run-only workflow without healing)
  • ogoron upgrade — upgrade the project metadata/configs when Ogoron changes
  • ogoron self — manage the Ogoron tool itself (for example, ogoron self update)

Typical flow (command map)​

Most workflows follow the same backbone:

  1. ogoron init
  2. Configure .ogoron/configs/
  3. ogoron analyze business (required before most generation workflows)
  4. ogoron generate ...
  5. ogoron heal ... (optional; when you need maintenance and failure reports)

ogoron generate subcommands​

Use ogoron generate when you want Ogoron to create new test assets or supporting artifacts.

  • ogoron generate unit-tests --module <Name> — generate unit tests for a specific module area
  • ogoron generate api-tests --entry <Query> — generate integration API tests from a free-form entrypoints query
  • ogoron generate test-cases --by-text <Text> / --file <Path> — generate test cases (human-readable) from a description
  • ogoron generate autotests — generate executable tests based on previously generated test cases

Examples:

ogoron generate unit-tests --module UserService
ogoron generate api-tests --entry "GET /api/spots" --description "AuthZ + pagination"
ogoron generate test-cases --by-text "Describe the feature and what must be tested"
ogoron generate autotests

ogoron heal subcommands​

Use healing workflows after tests exist and you want a run + diagnosis loop.

  • ogoron heal tests — run tests and produce a heal issues report
  • ogoron heal conflicts — apply human verdicts from the latest heal_conflicts.xml and attempt automated fixes for eligible issues

Examples:

ogoron heal tests
ogoron heal conflicts

ogoron run subcommands​

Use ogoron run when you want to execute tests without generating a heal-focused report.

  • ogoron run tests — run generated unit tests (by default: the latest batch)

Global flags​

  • --plain — CI/log-friendly output (disables Rich UI)
  • --no-color — disables colored output (also respects NO_COLOR=1)

Help and version​

ogoron --help
ogoron --version