Skip to main content

Quickstart

This guide assumes Ogoron is installed and you have OGORON_REPO_TOKEN configured.

If your organization is on a BYOK trial, also configure OGORON_LLM_API_KEY.

1) Initialize a target project

From the target project root:

ogoron init

Ogoron creates a .ogoron/ workspace directory and the initial config files:

  • .ogoron/configs/config.yml
  • .ogoron/configs/test_execution.yml

Validate configuration (recommended):

ogoron init validate

Next: review .ogoron/configs/ and adjust it for your repository.

2) Analyze the project (required)

Run project analysis before generation:

ogoron analyze business

Re-run ogoron analyze business when the project changes substantially (for example: a large refactor, a large new code area, or when outputs noticeably drift from what is expected).

3) Generate tests (pick a starting point)

Unit tests (module-based)

ogoron generate unit-tests --module UserService

With extra context:

ogoron generate unit-tests --module UserService --description "Authentication and authorization"

API tests (entrypoints query)

ogoron generate api-tests --entry "GET /api/spots"

With extra context:

ogoron generate api-tests --entry "GET /api/spots" --description "AuthZ + pagination"

UI tests (test cases → autotests)

First, generate test cases (from text):

ogoron generate test-cases --by-text "Describe the feature and what must be tested"

Or from a file:

ogoron generate test-cases --file ./request.txt

Then, generate executable tests from the produced test cases:

ogoron generate autotests

4) Review outputs

Ogoron writes human-friendly artifacts under:

.ogoron/for-human/

Ogoron also maintains merge-friendly registries intended for commit under:

.ogoron/keep-git/

Do not add .ogoron/keep-git/** to .gitignore.

Generated tests are written into your repository according to .ogoron/configs/.

5) Keep tests up to date (optional)

After generating tests, use the healing workflow to run tests and produce a report of failures:

ogoron heal tests