Skip to content

Commit 4bd93fb

Browse files
committed
docs: update cli.md
1 parent 4a48402 commit 4bd93fb

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

docs/development/cli.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,22 @@ $ npx --yes pkg out/cli/diffIndexGenerateCommit.js -t node18-macos
2222

2323
## Troubleshooting
2424

25-
On macOS, installed here:
25+
On macOS, installed here as a symlink pointing to the `.js` file in the repo:
2626

2727
```
2828
/opt/homebrew/bin/acm
2929
```
3030

31-
If you get permissions issues, remove and add again.
31+
If you get permissions issues, it is because the `.js` file was rebuilt and with standard permissions and needs to be linked again.
3232

3333
```sh
34-
$ npm unlink auto-commit-msg
35-
$ npm link auto-commit-msg
34+
$ npm run cli
3635
```
3736

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.
37+
Check:
38+
39+
```sh
40+
ls -l $(realpath /opt/homebrew/bin/acm)
41+
```
42+
43+
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 because of permissions issues.

0 commit comments

Comments
 (0)