/guia-cli

Gu, is a simple IA agent that specializes in software engineering, aiding in coding tasks and providing technical guidance.

Primary LanguagePythonCreative Commons Zero v1.0 UniversalCC0-1.0

Publish to PyPI Creative Commons https://img.shields.io/badge/made%20with-AI-blue


Project banner

AboutInstallationGetting StartedContributionLicense


About

GUIA-CLI (aka Gu IA Agent) is an agent specializing in software engineering, designed to assist in programming tasks and provide technical guidance.It is able to generate code based on provided requirements and answer technical questions, offering clear explanations and relevant recommendations.

Installation

You can install Guia-CLI via PyPI using pip:

pip install guia-cli

Alternatively, you can build from the repository:

  1. Clone the repository:
git clone https://github.com/andersonbosa/guia-cli.git
  1. Navigate to the repository directory:
cd guia-cli
  1. Install the package:
python setup.py install

Getting Started

To use the Gu agent, you can execute the command gu providing the following options:

  • --coding "YOUR REQUEST": Uses Gu agent programming ability to generate code based on your request.
  • --mentoring "YOUR QUESTION": Uses Gu agent mentoring ability to receive technical guidance in response to your question.

Demo image of command --help

Settings

Be sure to configure the following environment variables or it is setup in the .env file:

  • GOOGLE_API_KEY: Your Google API key to use Gemini service (required)
export GOOGLE_API_KEY="qwerty12345example"

Example of use

gu --coding "Implement a function to order a Python list using bubble-sort"
gu --mentoring "What is the difference between inheritance and composition in object -oriented programming?"

Backup results

The results of interactions with agent Gu are saved in the outputs folder. Each file generated contains the date, type of interaction and a description of the request.

🤝 Contribution

All kinds of contributions are very welcome and appreciated! This project is for study purposes too, so please send me a message telling me what you are doing and why you are doing it, teach me what you know.

📝 License

This project is under the public domain license.


GitHub Repo stars | Did you like the repository? Give it a star! 😁