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.3.tar.gz (11.0 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.3-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gitgenius-0.1.3.tar.gz
  • Upload date:
  • Size: 11.0 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.3.tar.gz
Algorithm Hash digest
SHA256 70e01943c36ad78592c6699605953902972bce94ce64df4bbf6bc414b833308b
MD5 eb2f4320f9b96106bac823abe3c10394
BLAKE2b-256 ae086f7fc5818b89e5866c0ac01f7b5a2979c58bc065ed5127d6af7562c6aa37

See more details on using hashes here.

Provenance

The following attestation bundles were made for gitgenius-0.1.3.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.3-py3-none-any.whl.

File metadata

  • Download URL: gitgenius-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 11.5 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 75a925dc3073b70d91504a7f17dc5a886cf5acb8cba0259af0b6b79468740cdb
MD5 4290bb143bca0a9815d2a732e2821f6e
BLAKE2b-256 1f3cc3b1445f68a112249f7701bc80090dda49f8c325617f628f0395665c423e

See more details on using hashes here.

Provenance

The following attestation bundles were made for gitgenius-0.1.3-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