docs: update cli.md, shell/README.md and TODO.md

Author: MichaelCurrin

docs/cli.md

@@ -5,39 +5,22 @@ See steps below to setup and run the tool in the CLI. VS Code is not needed.
 
 For development, see [CLI Development](development/cli.md).
 
-## Requirements
+_This should work on Windows too but has not been tested yet._
 
-- Node (see version in [package.json](/package.json))
-- Git
 
-_This should work on Windows too but has not been tested yet._
+## Install
 
-## Setup
+Requires Git and Node.
 
-### Clone the repo
+<!-- TODO replace with instructions for downloading from a release using manual steps and install with curl or npm
+Note you do not need Git or Node, you can download the pre-packaged CLI tool as a binary.
+-->
 
 ```sh
 $ git clone git@github.com:MichaelCurrin/auto-commit-msg.git
 $ cd auto-commit-msg
-```
-
-### Install dependencies
-
-```sh
-$ npm ci
-```
-
-### Build and link the CLI tools
-
-```sh
-$ npm run cli
-```
-
-Verify installation:
-
-```sh
-$ acm -h
-$ gacm -h
+$ npm install
+$ npm run cli:install
 ```
 
 ## Usage
@@ -55,12 +38,12 @@ TODO -c not just --cached but pass through as --cached.
 
 This is the **main** command you should use.
 
-Note this actually **commit**, so if you want to experiment with commit output **without** committing, use the command below instead.
+Note this will **commit**, so if you want to experiment with commit output **without** committing, use the command below instead.
 
 No flags are needed.
 
 ```sh
-$ gacm
+$ gacm --help
 ```
 
 ### Check Git changes and generate commit message
@@ -70,15 +53,13 @@ This will **not** commit.
 No flags are needed.
 
 ```sh
-$ acm
+$ acm --help
 ```
 
 ### Generate a message from staged changes
 
 This is a simpler command which does not interact with Git, intended for integrating with the Bash shell.
 
-See [shell/acm.sh](/shell/acm.sh) if you want to use that script or write your own shell script. That relies on using this executable Node script
-
 ```sh
 $ auto_commit_message_generate "$CHANGES"
 ```

shell/README.md

@@ -1,18 +1,21 @@
 
 # Shell
 
-See [acm-hook.sh](acm-hook.sh).
+See [acm-hook.sh](acm-hook.sh) script.
 
-A CLI script that bypasses using VS Code or an extension.
-It will get output from Git, send it to Node CLI entry-point tool and print
-it. This can be used as part of Git commit message hook flow (pre-commit hook).
+A Bash CLI script that bypasses using VS Code or an extension. It will get output from Git, send it to Node CLI entry-point tool and print
+it.
 
+This can be used as part of Git commit message hook flow such as a **pre-commit hook**.
+
+> [!NOTE]
+> For **cross-platform support**, see [CLI docs](/docs/cli.md) as that uses Node instead of Bash and also supports creating a pre-built binary for distribution. Also that approach uses a new command which wraps the Git commit logic, while shell acm-hook.sh script works the opposite way as called by Git.
 
 ## Setup
 
 If you want to use the hook:
 
-1. Follow instructions to install the TS command globally as per [src/cli/README.md](/src/cli/README.md)
+1. Follow instructions to install the commands globally as per [CLI docs](/docs/cli.md).
 1. Install the pre-commit hook.
     ```sh
     $ cp shell/acm-hook.sh YOUR_PROJECT/.hooks/pre-commit

shell/TODO.md

@@ -6,9 +6,10 @@ of template, so it that can be passed on.
 - [ ] Add a flag for staged to get `--cached` flag.
 - [ ] How to automated the install process for upgrades. Maybe the JS + shell script as NPM package or at least on GitHub with cURL install.
 - [ ] Figure out how to switch between staged and not, with `--cached`. Like passing a param to the shell script and having two aliases. Or to have it as pass of the shell script to fallback to all if anything is staged. Or just control with filenames e.g. `git c .` or `git c package*` - oh wait, the shell script doesn't look at what is passed to `git commit`, only what is staged or not.
-- Fix bug where message is on modified and staged but only staged is committed with gacm or acm
+- [ ] Fix bug where message is on modified and staged but only staged is committed with gacm or acm
 
     If the flag is omitted, then the standard `git status` logic is followed:
     look for staged changes and use them, otherwise use unstaged changes.
     there's a problem - commit does not take cached flag - but it will use implied staged or not. so do not pass through.
     BUT could look at advanced mode of pass through names of files to commit IF they are handled by status and commit, but using manual git add is good enough probably. esp for untracked files which need add anyway.
+- [ ] See if it is possible to make the shell script here shorter and use the logic in acm instead and a minimal .sh hook file.