Tidy CLI¶

The main git-tidy commands are listed below. Note that --help can be given as an argument to any of these commands to print out help on the command line.

git-tidy¶

Print version information about git-tidy or show the tidy commit template.

git-tidy [OPTIONS]

Options

--template¶: Show tidy commit template.

-o, --output <output>¶: Output file name of the commit template.

git-tidy-commit¶

Perform a tidy commit.

git-tidy-commit [OPTIONS]

Options

--no-verify¶: Disable running hooks.

--allow-empty¶: Allow an empty commit.

git-tidy-lint¶

Run tidy commit linting against a range of commits.

If :github/pr is provided as the range, the base branch of the pull request will be used as the revision range (e.g. origin/develop..).

git-tidy-lint [OPTIONS] [RANGE]...

Options

--any¶: Make linting pass if at least one commit is valid

Arguments

RANGE¶: Optional argument(s)

git-tidy-log¶

Run tidy log output against a range of commits.

If :github/pr is provided as the range, the base branch of the pull request will be used as the revision range (e.g. origin/develop..). If :github/pr is used as the output target, the log will be written as a comment on the current Github pull request.

git-tidy-log [OPTIONS] [RANGE]...

Options

--style <style>¶

--tag-match <tag_match>¶: A glob(7) pattern for matching tags when associating a tag with a commit in the log. Passed to git describe --contains --matches when associating a tag with a commit.

--before <before>¶: Filter commits before a date.

--after <after>¶: Filter commits after a date.

--reverse¶: Reverse ordering of results.

-o, --output <output>¶: Output file name of the log.

Arguments

RANGE¶: Optional argument(s)

git-tidy-squash¶

Squash commits from ref commit into a single commit.

If :github/pr is provided as the ref, the base branch of the pull request will be used (e.g. origin/develop).

git-tidy-squash [OPTIONS] REF

Options

--no-verify¶: Disable running hooks.

--allow-empty¶: Allow an empty commit.

Arguments

REF¶: Required argument