Detail CLI

The main detail 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.

detail

detail [OPTIONS] COMMAND [ARGS]...

detail

Create a new note or print the version of this library.

If a note path is provided, it will be updated.

detail detail [OPTIONS] [NOTE]

Options

-v, --version

Show the version.

Arguments

NOTE

Optional argument

lint

Run note 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..).

detail lint [OPTIONS] [RANGE]...

Arguments

RANGE

Optional argument(s)

log

Run log output against a range of notes.

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.

detail log [OPTIONS] [RANGE]...

Options

--style <style>

A template file nickname to use. Defaults to .detail/log.tpl. When provided, .detail/log_{style}.tpl is loaded.

--template <template>

A template string to use. When provided, supercedes the “style” option.

--tag-match <tag_match>

A glob(7) pattern for matching tags when associating a tag with a note. Passed to git describe --contains --matches when associating a tag with committed notes.

--before <before>

Filter notes before a date.

--after <after>

Filter notes after a date.

--reverse

Reverse ordering of results.

-o, --output <output>

Output file name of the log.

Arguments

RANGE

Optional argument(s)