gitmsg - Installation Instructions

This guide will walk you through the steps to install a TypeScript GitHub repository that uses Node.js to run a CLI tool.

Prerequisites

Before you begin, ensure that you have the following software installed on your machine:

• Node.js: Make sure you have Node.js installed. You can download and install it from the official website: https://nodejs.org
• Git: Ensure that Git is installed on your machine. If not, you can download and install it from the official website: https://git-scm.com
• OpenAI API Key: You will need an OpenAI API key to use this tool. You can get one by signing up for an account at https://platform.openai.com/. Once you have an account, you can find your API key on the https://platform.openai.com/account/api-keys page.

Installation Steps

1. Clone the repository:

   git clone https://github.com/alismx/gitmsg.git
   

2. Navigate to the project directory:

   cd gitmsg
   

3. Install dependencies by running the following command:

   npm install
   

   This command will install all the required dependencies listed in the package.json file.

4. Build the TypeScript code:

   npm run build
   

   This command compiles the TypeScript code into JavaScript.

5. Add /usr/local/bin/gitmsg file with contents:

   #!/bin/sh
   node ~/path/to/gitmsg/dist $1
   

6. Add these environment variables to your profile:

   GITMSG_OPENAI_API_KEY
   GITMSG_COMMIT_PROMPT
   GITMSG_PR_PROMPT
   

Suggested commit message prompt:

'I want you to act as a software developer. I will provide you with a `git diff`, and it will be your job to write a succinct commit message, adhering to "conventional commit" rules for this change. Only include the commit message text. Do not include information about commit messages or how to compose commit messages.'

Suggested pull request message prompt:

'I want you to act as a software developer. I will provide you with a `git diff`, and it will be your job to write a succinct pull request description with the following template: \n## Changes Proposed \n\n- Detailed explanation of what this PR should do \n\n## Additional Information \n\n- decisions that were made \n- notice of future work that needs to be done \n\n## Testing \n\n- How should reviewers verify this PR?\n\nOnly include the description text. Do not include information about pull requests or how to compose a pull request description.'

If you have any issues with the installation or encounter any bugs, please open an issue.

Usage

Generate a commit message based on changes in stages files and commit them:

gitmsg

Generate a pull request message based on changes against main (you optionally can specify a branch and specific files):

gitmsg --pr <file1> <file2> ... --branch <origin/my-branch>

Display usage information:

gitmsg --help

Amend the last commit with staged files:

gitmsg --amend

Undo the last commit:

gitmsg --undo