Skip to content

Commit 812c677

Browse files
committed
docs: update cli.md and cli.md
1 parent 10e7d85 commit 812c677

File tree

2 files changed

+13
-8
lines changed

2 files changed

+13
-8
lines changed

docs/cli.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,9 @@ $ gacm -h
4545
Use the `-h` or `--help` flags with any of these to avoid making changes.
4646

4747
<!--
48-
TODO consolidate to one command with commit flag?
48+
TODO consolidate to one command with commit flag or dry run?
4949
TODO pass params like file names through for either command. For message and committing. The downside is for new files - even if git commit would pick them up by name, diff-index would not. You can also use whatever IDE to stage and still generate+commit with the CLI.
50-
TODO -c not just --cached
50+
TODO -c not just --cached but pass through as --cached.
5151
-->
5252

5353
### Generate a message from changes and commit

docs/development/cli.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,19 @@
22

33
The code is in [src/bin/](/src/bin).
44

5-
The CLI commands are built using steps set in [package.json](/package.json) - see the `cli*` scripts and `bin` sections.
5+
The CLI commands are built using steps set in [package.json](/package.json) - see the `cli` scripts and `bin` section.
66

7-
### Test
7+
## Package as a binary
88

9-
Test the TS files directly.
9+
```sh
10+
$ npx --yes pkg out/bin/diffIndexGenerateCommit.js -t node18-macos
11+
```
12+
13+
## Troubleshooting
14+
15+
If you get permissions issues, remove and add again.
1016

1117
```sh
12-
npx --yes ts-node src/bin/diffIndexGenerate.ts -h
13-
npx --yes ts-node src/bin/diffIndexGenerateCommit.ts -h
14-
npx --yes ts-node src/bin/generate.ts -h
18+
$ npm unlink auto-commit-msg
19+
$ npm link auto-commit-msg
1520
```

0 commit comments

Comments
 (0)