Skip to content

Commit 341af6d

Browse files
committed
docs: update cli.md and releases.md
1 parent 30fe8e2 commit 341af6d

2 files changed

Lines changed: 11 additions & 3 deletions

File tree

docs/development/cli.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,12 @@ The code is in [src/cli/](/src/cli). The CLI commands are built using steps set
88

99
## Run directly
1010

11-
For testing:
11+
Run a script directly without compiling:
1212

1313
```sh
1414
$ npx ts-node src/cli/diffIndexGenerate.ts
15+
$ npx ts-node src/cli/diffIndexGenerateCommit.ts
16+
$ npx ts-node src/cli/generate.ts
1517
```
1618

1719
## Install globally

docs/development/releases.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,15 @@ Release uploads are configured in [release.yml](/.github/workflows/release.yml).
88

99
See [softprops/action-gh-release](https://github.com/softprops/action-gh-release) on GH for more info.
1010

11-
> [!NOTE]
12-
> The release must not be ticked ase pre-release or the URL will not work: https://github.com/MichaelCurrin/auto-commit-msg/releases/latest/download/acm-macos
11+
> [!WARNING]
12+
> The release must **not** be ticked as pre-release or this URL will not work: https://github.com/MichaelCurrin/auto-commit-msg/releases/latest/download/acm-macos
1313
1414
## Download
1515

1616
See [bin](/bin/) for scripts used for users to get the distributed binaries.
17+
18+
Test the install script locally without curl to install from a release:
19+
20+
```sh
21+
$ bin/install_cli.sh
22+
```

0 commit comments

Comments
 (0)