Skip to content

Commit 8cdf706

Browse files
committed
docs(cli): inform --changelog requires --unstable-kv
1 parent de035e4 commit 8cdf706

File tree

2 files changed

+15
-17
lines changed

2 files changed

+15
-17
lines changed

cli/README.md

+14-16
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# @molt/cli
2-
31
## Installation (optional)
42

53
The molt CLI can be installed globally with the following command, for example:
@@ -32,20 +30,20 @@ Description:
3230
3331
Options:
3432
35-
-h, --help - Show this help.
36-
-v, --version - Print version info.
37-
-w, --write - Write changes to the local files. (Conflicts: --commit)
38-
-c, --commit - Commit changes to the local git repository. (Conflicts: --write)
39-
--changelog [types] - Print a curated changelog for each update.
40-
--config <file> - Specify the Deno configuration file.
41-
--dry-run - See what would happen without actually doing it.
42-
--ignore <pattern> - Specify dependencies to ignore.
43-
--only <pattern> - Specify dependencies to check.
44-
--lock <file> - Specify the lock file.
45-
--no-config - Disable automatic loading of the configuration file.
46-
--no-lock - Disable automatic loading of the lock file.
47-
--pre-commit <tasks> - Run tasks before each commit (Depends: --commit)
48-
--prefix <prefix> - Prefix for commit messages (Depends: --commit)
33+
-h, --help - Show this help.
34+
-v, --version - Print version info.
35+
-w, --write - Write changes to the local files. (Conflicts: --commit)
36+
-c, --commit - Commit changes to the local git repository. (Conflicts: --write)
37+
--changelog [types] - Print commits for each update. (requires --unstable-kv)
38+
--config <file> - Specify the Deno configuration file.
39+
--dry-run - See what would happen without actually doing it.
40+
--ignore <pattern> - Specify dependencies to ignore.
41+
--only <pattern> - Specify dependencies to check.
42+
--lock <file> - Specify the lock file.
43+
--no-config - Disable automatic loading of the configuration file.
44+
--no-lock - Disable automatic loading of the lock file.
45+
--pre-commit <tasks> - Run tasks before each commit (Depends: --commit)
46+
--prefix <prefix> - Prefix for commit messages (Depends: --commit)
4947
--referrer - Print files that import the dependency.
5048
```
5149

cli/main.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ const main = new Command()
2020
})
2121
.option(
2222
"--changelog=[types:string[]]",
23-
"Print a curated changelog for each update.",
23+
"Print commits for each update. (requires --unstable-kv)",
2424
)
2525
.option("--config <file:string>", "Specify the Deno configuration file.")
2626
.option("--dry-run", "See what would happen without actually doing it.")

0 commit comments

Comments
 (0)