@@ -32,3 +32,45 @@ yarn add @tomjs/release-cli -D
3232# npm
3333npm add @tomjs/release-cli -D
3434```
35+
36+ ## Usage
37+
38+ ``` bash
39+ $ rc --help
40+
41+ A CLI tool to automatically publish npm packages.
42+
43+ Usage
44+ $ rc [type] [options]
45+
46+ Type can be:
47+ patch | minor | major | prepatch | preminor | premajor | prerelease
48+
49+ Options
50+ --cwd < cwd> The current working directory (default: " ."
51+ --preid Specify the pre-release identifier, allowed values are " " " alpha" " beta" " rc"
52+ If type is " prerelease" " prepatch" " preminor" " premajor"
53+ the preid will be used as the pre-release identifier (default: " alpha"
54+ If type is " patch" " minor" " major"
55+ --any-branch Allow publishing from any branch (default: false)
56+ --branch Name of the release branch (default: main | master)
57+ --tag < tag> Publish under a given dist-tag (default: " latest"
58+ --scoped-tag Use scoped package name as git tag (default: false)
59+ --no-log Skips generating changelog
60+ --log-full Generate a full changelog and replace the existing content (default: false)
61+ --no-log-commit Don' t add git commit SHA and link to the changelog
62+ --no-log-compare Don' t add git compare link to the changelog
63+ --git-url Specify the git web url. If not specified, the configuration of git or package.json will be read,
64+ such as " https://github.com/tomjs/release-cli"
65+ --git-commit-url Git commit url template, default: " {url}/commit/{sha}"
66+ --git-compare-url Git compare url template, default: " {url}/compare/{diff}"
67+ --strict Strict mode, will make some checks more strict (default: false)
68+ --no-publish Skips publishing
69+ --tag-one When publishing multiple packages, only one git tag and commit (default: false)
70+ --otp This is a one-time password from a two-factor authenticator
71+ --no-release-draft Skips opening a GitHub release draft
72+ --dry-run Don' t actually release, just simulate the process
73+ --verbose Display verbose output
74+ -h, --help Display this message
75+ -v, --version Display version number
76+ ```
0 commit comments