|
| 1 | +# CLI |
| 2 | +> How to use AutoCommitMsg in the terminal instead of as an extension |
| 3 | +
|
| 4 | +See steps below to setup and run the tool in the CLI. VS Code is not needed. |
| 5 | + |
| 6 | +For development, see [CLI Development](development/cli.md). |
| 7 | + |
| 8 | +_This should work on Windows too but has not been tested yet._ |
| 9 | + |
| 10 | + |
| 11 | +## Install |
| 12 | + |
| 13 | +Requires Git and Node. |
| 14 | + |
| 15 | +<!-- TODO replace with instructions for downloading from a release using manual steps and install with curl or npm |
| 16 | +Note you do not need Git or Node, you can download the pre-packaged CLI tool as a binary. |
| 17 | +--> |
| 18 | + |
| 19 | +```sh |
| 20 | +$ git clone git@github.com:MichaelCurrin/auto-commit-msg.git |
| 21 | +$ cd auto-commit-msg |
| 22 | +$ npm install |
| 23 | +$ npm run cli:install |
| 24 | +``` |
| 25 | + |
| 26 | +To setup as a pre-commit hook, see [Shell](/shell/) |
| 27 | + |
| 28 | +## Usage |
| 29 | + |
| 30 | +Use the `-h` or `--help` flags with any of these to avoid making changes. |
| 31 | + |
| 32 | +<!-- |
| 33 | +TODO consolidate to one command with commit flag or dry run? |
| 34 | +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. |
| 35 | +TODO -c not just --cached but pass through as --cached. |
| 36 | + And use default behavior for if there is staged then use that for commit message - make it smart. |
| 37 | +--> |
| 38 | + |
| 39 | +### Generate a message from changes and commit |
| 40 | + |
| 41 | +This is the **main** command you should use. |
| 42 | + |
| 43 | +Note this will **commit**, so if you want to experiment with commit output **without** committing, use the command below instead. |
| 44 | + |
| 45 | +No flags are needed. |
| 46 | + |
| 47 | +```sh |
| 48 | +$ gacm --help |
| 49 | +``` |
| 50 | + |
| 51 | +### Check Git changes and generate commit message |
| 52 | + |
| 53 | +This will **not** commit. |
| 54 | + |
| 55 | +No flags are needed. |
| 56 | + |
| 57 | +```sh |
| 58 | +$ acm --help |
| 59 | +``` |
| 60 | + |
| 61 | +### Generate a message from staged changes |
| 62 | + |
| 63 | +This is a simpler command which does not interact with Git, intended for integrating with the Bash shell. |
| 64 | + |
| 65 | +```sh |
| 66 | +$ auto_commit_message_generate "$CHANGES" |
| 67 | +``` |
| 68 | + |
| 69 | +### Usage tips |
| 70 | + |
| 71 | +The behavior depends on how Git treats files, so you should know these points: |
| 72 | + |
| 73 | +- The commands will pick up on staged changes and certain unstaged changes (modified and deleted, but not created as they are untracked). |
| 74 | +- If you want to handle created files, make sure to stage them first. |
| 75 | +- If you want to target only select changes for smaller commit, then stage stages and use the `--cached` flag to ignored unstaged changes. |
| 76 | + |
| 77 | +## Uninstall the linked CLI (optional) |
| 78 | + |
| 79 | +If you get permission denied error, you can do this and then go back to the install step. |
| 80 | + |
| 81 | +```sh |
| 82 | +$ npm unlink -g auto-commit-msg |
| 83 | +``` |
0 commit comments