You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+35-42
Original file line number
Diff line number
Diff line change
@@ -90,48 +90,41 @@ Otherwise, ensure you have the `clog` binary in the directory which you operatin
90
90
`clog` works by reading your `git` metadata and specially crafted commit messages and subjects to create a changelog. `clog` has the following options available.
91
91
92
92
```sh
93
-
USAGE:
94
-
clog [FLAGS] [OPTIONS]
95
-
96
-
FLAGS:
97
-
-F, --from-latest-tag use latest tag as start (instead of --from)
98
-
-h, --help Prints help information
99
-
-M, --major Increment major version by one (Sets minor and patch to 0)
100
-
-m, --minor Increment minor version by one (Sets patch to 0)
101
-
-p, --patch Increment patch version by one
102
-
-V, --version Prints version information
103
-
104
-
OPTIONS:
105
-
-C, --changelog <changelog> A previous changelog to prepend new changes to (this is like
106
-
using the same file for both --infile and --outfile and
107
-
should not be used in conjunction with either)
108
-
-c, --config <config> The Clog Configuration TOML file to use (Defaults to
109
-
'.clog.toml')**
110
-
-T, --format <format> The output format, defaults to markdown
111
-
(valid values: markdown, json)
112
-
-f, --from <from> e.g. 12a8546
113
-
-g, --git-dir <gitdir> Local .git directory (defaults to current dir + '.git')*
114
-
-i, --infile <infile> A changelog to append to, but *NOT* write to (Useful in
115
-
conjunction with --outfile)
116
-
-o, --outfile <outfile> Where to write the changelog (Defaults to stdout when omitted)
117
-
-r, --repository <repo> Repository used for generating commit and issue links
118
-
(without the .git, e.g. https://github.com/clog-tool/clog-cli)
119
-
-l, --link-style <style> The style of repository link to generate
120
-
(Defaults to github) [values: Github Gitlab Stash]
121
-
-s, --subtitle <subtitle> e.g. "Crazy Release Title"
122
-
-t, --to <to> e.g. 8057684 (Defaults to HEAD when omitted)
123
-
--setversion <ver> e.g. 1.0.1
124
-
-w, --work-tree <workdir> Local working tree of the git project
125
-
(defaults to current dir)*
126
-
127
-
* If your .git directory is a child of your project directory (most common, such as
128
-
/myproject/.git) AND not in the current working directory (i.e you need to use --work-tree or
129
-
--git-dir) you only need to specify either the --work-tree (i.e. /myproject) OR --git-dir (i.e.
130
-
/myproject/.git), you don't need to use both.
131
-
132
-
** If using the --config to specify a clog configuration TOML file NOT in the current working
133
-
directory (meaning you need to use --work-tree or --git-dir) AND the TOML file is inside your
134
-
project directory (i.e. /myproject/.clog.toml) you do not need to use --work-tree or --git-dir.
93
+
Usage: clog [OPTIONS]
94
+
95
+
Options:
96
+
-r, --repository <URL> Repository used for generating commit and issue links (without the .git, e.g.
97
+
https://github.com/thoughtram/clog)
98
+
-f, --from <COMMIT> e.g. 12a8546
99
+
-T, --format <STR> The output format, defaults to markdown [default: markdown] [possible values: markdown,
100
+
json]
101
+
-M, --major Increment major version by one (Sets minor and patch to 0)
102
+
-g, --git-dir <PATH> Local .git directory (defaults to "$(pwd)/.git")
103
+
-w, --work-tree <PATH> Local working tree of the git project (defaults to "$(pwd)")
104
+
-m, --minor Increment minor version by one (Sets patch to 0)
105
+
-p, --patch Increment patch version by one
106
+
-s, --subtitle <STR>
107
+
-t, --to <COMMIT> e.g. 8057684 [default: HEAD]
108
+
-o, --outfile <PATH> Where to write the changelog (Defaults to stdout when omitted)
109
+
-c, --config <COMMIT> The Clog Configuration TOML file to use [default: .clog.toml]
110
+
-i, --infile <PATH> A changelog to append to, but *NOT* write to (Useful in conjunction with --outfile)
111
+
--setversion <VER> e.g. 1.0.1
112
+
-F, --from-latest-tag use latest tag as start (instead of --from)
113
+
-l, --link-style <STR> The style of repository link to generate [default: github] [possible values: github,
114
+
gitlab, stash, cgit]
115
+
-C, --changelog <PATH> A previous changelog to prepend new changes to (this is like using the same file for both
116
+
--infile and --outfile and should not be used in conjunction with either)
117
+
-h, --help Print help
118
+
-V, --version Print version
119
+
120
+
121
+
If your .git directory is a child of your project directory (most common, such as /myproject/.git) AND not in the
122
+
current working directory (i.e you need to use --work-tree or --git-dir) you only need to specify either the
123
+
--work-tree (i.e. /myproject) OR --git-dir (i.e. /myproject/.git), you don't need to use both.
124
+
125
+
If using the --config to specify a clog configuration TOML file NOT in the current working directory (meaning you
126
+
need to use --work-tree or --git-dir) AND the TOML file is inside your project directory (i.e.
127
+
/myproject/.clog.toml) you do not need to use --work-tree or --git-dir.
0 commit comments