Skip to content

CLI Reference

This reference is generated from the argparse definitions used by Gearu. Do not edit the mechanical help text directly; update the CLI and regenerate it.

python scripts/generate_cli_reference.py --write
python scripts/generate_cli_reference.py --check

gearu

usage: gearu [-h] [--version] {init,plan,release} ...

Make repositories ready for release.

positional arguments:
  {init,plan,release}
    init               install or update repository release guidance
    plan               validate and display a release plan
    release            prepare, verify, commit, and tag a release

options:
  -h, --help           show this help message and exit
  --version            show program's version number and exit

Project: https://github.com/owebeeone/gearu

gearu init

usage: gearu init [-h] [--repo REPO]

options:
  -h, --help   show this help message and exit
  --repo REPO  repository or a path inside it (default: current directory)

gearu plan

usage: gearu plan [-h] [--repo REPO] [--dependency-tag NAME=TAG]
                  (--bump {major,minor,patch} | version)

positional arguments:
  version               explicit release version, e.g. 1.2.3 or v1.2.3

options:
  -h, --help            show this help message and exit
  --bump {major,minor,patch}
                        select the next version from configured versions and release
                        tags
  --repo REPO           repository or a path inside it (default: current directory)
  --dependency-tag NAME=TAG
                        override one configured dependency tag; repeat as needed

gearu release

usage: gearu release [-h] [--repo REPO] [--dependency-tag NAME=TAG] [--push]
                     [--github-release]
                     (--bump {major,minor,patch} | version)

positional arguments:
  version               explicit release version, e.g. 1.2.3 or v1.2.3

options:
  -h, --help            show this help message and exit
  --bump {major,minor,patch}
                        select the next version from configured versions and release
                        tags
  --repo REPO           repository or a path inside it (default: current directory)
  --dependency-tag NAME=TAG
                        override one configured dependency tag; repeat as needed
  --push                atomically push the exact branch commit and tag
  --github-release      create the GitHub Release after pushing the tag (requires
                        --push)