Skip to content

Latest commit

 

History

History
84 lines (52 loc) · 2.52 KB

README.md

File metadata and controls

84 lines (52 loc) · 2.52 KB
Raw

Git Assistant

Git Assistant is a tool harnessing the power of generative AI to assist Git users.

  • chatbot: Engage with a chatbot to question a repository.
  • generate-readme: Automatically generate comprehensive README.md files describing Git repositories.

Web Interface

Access to the git-assistant web interface: https://git-assistant.streamlit.app/

git_assistant_demo.mp4

Command line Interface

With command line interface, you need to specify you OpenAI API token. Tutorial to get your free API token : https://www.youtube.com/watch?v=EQQjdwdVQ-M"

Installation

Install git-assistant within your environment.

pip install git-assistant

Generate a README file

To generate a README.md file for a local git repository, execute the following command in a local git repository.

git-assistant generate-readme

For a remote repository, provide the repo_url parameter. For example:

# example
git-assistant generate-readme --repo_url=https://github.com/AntoinePinto/easyenvi

Interact with the chatbot

To engage with a chatbot associated with a local git repository, execute the following command inside a local git repository.

git-assistant chatbot

For a chatbot linked to a remote repository, specify the repo_url parameter. For example:

# example
git-assistant chatbot --repo_url=https://github.com/AntoinePinto/easyenvi
git_assistant_command_line_demo.mp4

Note: Only files present in the git repository are used by Git Assistant. Files listed in .gitignore are not considered.

Extra features

Specify GPT model

To select a specific GPT model, utilize the gpt_model parameter. For example:

git-assistant generate-readme --gpt_model=gpt-4-0613

Push .gitassistant to simplify chatbot access for your repository visitors

When you initialise Git Assistant on one of your projects, a .gitassistant folder is automatically created at the root of your repository. This folder contains the metadata required for the tool to function. By pushing the .gitassistant folder to your remote repository, you enable your visitors to access the ChatBot more conveniently, without the need to reinitialize git-assistant.

You can also indicate in your README.md file that a chatbot is easily accessible by executing the commands:

pip install git-assistant

Then:

git-assistant chatbot --repo_url=<YOUR_REPO_URL>