Skip to main content

GitGenius CLI - Understand Git errors in plain English

Project description

GitGenius CLI Logo

GitGenius CLI

Understand Git errors in plain English – directly from your terminal.

PyPI Version Python Versions License: MIT GitHub Stars GitHub Issues Last Commit


📦 Installation

Install GitGenius using:

pip install gitgenius

Or from the local source:

pip install .

🚀 Usage

Basic command:

gitgenius "fatal: not a git repository"

Or run the assistant mode:

gitgenius --admin

✅ Example Output

Explanation: This error means you're trying to run a Git command outside a Git repository.
Solution: Navigate to a folder that is a Git repo, or initialize one with `git init`.

🧪 Run Tests

python3 -m unittest discover tests

💡 Features

  • Explains Git errors in simple terms.
  • Suggests solutions and fixes.
  • CLI and admin assistant modes available.
  • Lightweight and beginner-friendly tool.

❓ Why GitGenius?

Git errors can be frustrating, especially for beginners. GitGenius makes it easier to:

  • Understand what's wrong.
  • Know how to fix it.
  • Learn Git through the terminal.

🖥️ Compatibility

  • ✅ Windows (CMD/PowerShell) (emoji support optional, see below)
  • ✅ Linux
  • ✅ macOS

⚠️ Windows CMD Emoji Issue

Windows CMD does not support emojis by default.

💡 Fix Options:

  • Use Windows Terminal, PowerShell, or Git Bash.
  • Or remove emojis by adding a --no-emoji flag in your tool (recommended feature to add).

📜 License

This project is licensed under the MIT License.


🌟 Star & Contribute

If you find this project helpful, give it a ⭐ on GitHub! Feel free to fork and improve the tool — contributions are welcome.


📫 Contact

Built with ❤️ by Selva Neyas U


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gitgenius-0.1.2.tar.gz (8.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gitgenius-0.1.2-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

Details for the file gitgenius-0.1.2.tar.gz.

File metadata

  • Download URL: gitgenius-0.1.2.tar.gz
  • Upload date:
  • Size: 8.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for gitgenius-0.1.2.tar.gz
Algorithm Hash digest
SHA256 3e29692a6d839fc4b48d305b7eb660b2630b8568d53dc5d37fd64a30efdc1a79
MD5 7e7219a0fa216756db2d417b647eb17a
BLAKE2b-256 89db74e73c47aab621defe5a13f7bfb8c4d6dfe4f896f9fde7639228cd6bbe23

See more details on using hashes here.

Provenance

The following attestation bundles were made for gitgenius-0.1.2.tar.gz:

Publisher: publish.yml on selvaneyas/gitgenius

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gitgenius-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: gitgenius-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 9.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for gitgenius-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9f434fdaf1c612f955522c5f100ced08fc9883ba94706e4116732dcfe19cbf81
MD5 99948af8e01bb0603096b105c7120adb
BLAKE2b-256 092a5ee67051be13a595ac650ec07aee8603f03161835964ff14908aa3d0b139

See more details on using hashes here.

Provenance

The following attestation bundles were made for gitgenius-0.1.2-py3-none-any.whl:

Publisher: publish.yml on selvaneyas/gitgenius

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page