Skip to content

Home

Jump to bottom
Seth Webster edited this page Aug 4, 2023 · 1 revision

Ava-Commit

Welcome to the Ava-Commit wiki page! Ava-Commit is a powerful tool that helps you generate informative commit messages for your Git projects. This wiki page will provide you with all the information you need to get started with Ava-Commit.

Table of Contents

Installation

To install Ava-Commit, you can use the following command:

npm install -g ava-commit

This command will install Ava-Commit globally on your system, allowing you to use it from anywhere in your terminal or command prompt.

Configuration

The configure command in Ava-commit allows users to customize the tool according to their specific needs and preferences. It enables them to set various options and parameters that control the behavior and functionality of Ava-commit.

Usage

To configure Ava-commit, run the following command:

ava-commit configure

This will trigger the configure command and open the configuration interface.

Configuration Options

When running ava-commit configure, users will be asked to provide the following information:

  1. openAIApiKey: Users need to enter their OpenAI API key. This key is required for Ava-commit to interact with the OpenAI service and generate summaries.

  2. Preferred Model for Summarizing Diffs: Users can choose their preferred model for summarizing code changes, also known as "diffs". The model selected will determine the quality and accuracy of the generated summaries.

  3. Preferred Model for Summarizing Summaries: Users can select their preferred model for summarizing previously generated summaries. This allows for more concise and informative commit messages.

  4. Preferred Language for the Tool: Users can choose their preferred language for the Ava-commit tool. This selection affects the language used in the user interface and any prompts or messages displayed by the tool.

  5. Preferred Language for Commit Messages: Users can specify their preferred language for the generated commit messages. This ensures that the commit messages align with the project's language conventions and guidelines.

NOTE: The specific configuration options available may vary depending on the implementation of Ava-commit and the version being used. The provided options are based on general knowledge about configuring code review tools.

First Use

After you've installed Ava-Commit, you can start using it right away. Here's an example of how you might use Ava-Commit to generate a commit message for your first commit:

  1. Navigate to your Git repository in your terminal or command prompt.

    cd /path/to/your/repository

  2. Make some changes to your code. For example, you might add a new function or fix a bug.

  3. Stage your changes with Git.

    git add .

    Note that if you do not stage your changes, ava-commit will offer to do that for you. If you opt not to do so, only staged changes will be analyzed.

  4. Use Ava-Commit to generate a commit message.

    ava-commit generate

  5. Ava-Commit will analyze your code changes and suggest some commit message options. Select one of the suggested messages, or you may choose to regenerate, or combine messages. You can keep going until you are happy.

  6. Your changes are now committed with a descriptive message generated by Ava-Commit!

Remember, this is just one example of how you can use Ava-Commit. The tool offers many other features and options to enhance your Git workflow. For more detailed usage examples and information, refer to the Ava-Commit Command Reference file.

Command Reference

Ava-Commit provides several commands that you can use to enhance your Git workflow. Here are some of the most commonly used commands:

  • ava-commit generate: Generates a commit message for your changes.
  • ava-commit configure: Configures Ava-Commit settings.
  • ava-commit update: Checks for updates for Ava-Commit.
  • ava-commit release-notes: Generates release notes based on changes since the last tag.

For a full list of available commands and their descriptions, refer to the Ava-Commit Command Reference file.

Updating Ava-Commit

It's important to keep Ava-Commit up to date to ensure you have access to the latest features and bug fixes. To update Ava-Commit, you can use the following command:

npm update -g ava-commit

Please note that this will only update the Ava-Commit package itself, not your project files. To update your project, you would typically use the package manager for your specific programming language or framework.

Thank you for using Ava-Commit! If you have any further questions, please don't hesitate to ask.

I hope you find this updated wiki page helpful! If you have any more questions or need further assistance, feel free to ask.

Clone this wiki locally