Skip to content

Commit 9c099c6

Browse files
committed
docs: update cli.md
1 parent ec6151b commit 9c099c6

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

docs/development/cli.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
The code is in [src/cli/](/src/cli). The CLI commands are built using steps set in [package.json](/package.json) - see the `cli` command and `bin` section.
55

66

7+
78
## Run directly
89

910
```sh
@@ -21,9 +22,17 @@ $ npx --yes pkg out/cli/diffIndexGenerateCommit.js -t node18-macos
2122

2223
## Troubleshooting
2324

25+
On macOS, installed here:
26+
27+
```
28+
/opt/homebrew/bin/acm
29+
```
30+
2431
If you get permissions issues, remove and add again.
2532

2633
```sh
2734
$ npm unlink auto-commit-msg
2835
$ npm link auto-commit-msg
2936
```
37+
38+
See [package.json](/package.json). Supposedly you should be able to leave out the project name when running `npm link` via an `npm run ...` command but I found this causes issues, so decided to always use the full name in the configuration. And to always unlink then link in one go.

0 commit comments

Comments
 (0)