Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Support

Ganzua is Open Source software, provided to you free of charge and on an "as is" basis. You are not entitled to support, help, or bugfixes of any kind.

Nevertheless, the Ganzua project may occasionally offer help.

Ganzua is Open Source but not open contribution. Please do not submit code changes. If you want to help with feature work or bugfixes, instead report an issue, and provide an analysis of the problem.

Humans are welcome, bots are not. LLM-generated submissions will be deleted without discussion.

Stability policy

Ganzua intends to maintain a backwards-compatible command line interface, and intends to use SemVer version numbers.

Only those parts of the CLI that are relevant for scripting are covered by this stability policy:

  • commands that inspect or modify files
  • machine-readable output, e.g. the schema of JSON output

For example, Ganzua might increment the "minor" version number if a new field is added to JSON output or if new command line options are added, and increment the "major" version if output fields are removed or new required command line arguments are added.

Many other features are out of scope of this stability policy. Arbitrary changes here are expected, will happen without notice, and without major version bumps. Examples:

  • interacting with ganzua as a Python module – you must stick to the CLI
  • Python versions or dependency versions used by Ganzua – isolated installations via pipx or uvx/uv tool are highly recommended
  • formatting of human-readable output (e.g. Markdown) – use the JSON output if you're scripting with Ganzua
  • formatting of error messages
  • commands and flags that relate to help messages