Skip to main content

A simple CLI tool to automate Git setup, GitHub repo creation, and SSH configuration.

Project description

Git Wizard (gitw) 🧙‍♂️

A simple CLI tool to automate Git setup and streamline everyday version control tasks.

🚀 Features

  • Global Configuration: Interactively set your global Git user name and email.
  • Smart Push: Automatically stages changes, commits with a message, and pushes to the remote repository. Handles basic errors and suggests fixes.

📋 Requirements

  • Python 3.9+
  • Git installed and available in your system's PATH.

📦 Installation

PyPI

You can install git-wizard directly from PyPI using pip:

pip install git-wizard

AUR (Arch Linux)

Install from the AUR using yay:

yay -S git-wizard

Note: This package depends on python-inquirer, which is available in the AUR. Using an AUR helper like yay or paru is recommended to handle dependencies automatically. If you are building manually, please ensure python-inquirer is installed first.

Debian/Ubuntu (.deb)

Download the latest .deb release from the Releases page.

sudo apt install ./git-wizard_*.deb

Fedora/RedHat (.rpm)

Download the latest .rpm release from the Releases page.

sudo dnf install ./git-wizard-*.rpm

For Development (Editable Install)

If you want to contribute or modify the code:

  1. Clone the repository:

    git clone https://github.com/noufalkdlr/git-wizard.git
    cd git-wizard
    
  2. Create a virtual environment and install:

    python -m venv venv
    source venv/bin/activate  # On Windows use: venv\Scripts\activate
    pip install -e .
    

💻 Usage

1. Help Command

View all available commands and options:

gitw --help

2. Configure Git (Global)

Set up your global git user.name and user.email interactively:

gitw config

3. Push Changes

Stage all files, commit, and push in one go:

gitw push

4. Connect Repository

Initialize a local repository, create a commit, and push to GitHub in a single command. It supports both SSH and HTTPS protocols and integrates with GitHub CLI for seamless authentication.

gitw connect

💡 Pro Tip: Install GitHub CLI (gh) for the best experience. It allows git-wizard to automatically detect your GitHub username and preferred protocol (SSH/HTTPS), skipping those prompts!

📄 License

This project is licensed under the GNU General Public License v3.0 (GPLv3). See the LICENSE file for details.

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

git_wizard-0.2.0.tar.gz (16.9 kB view details)

Uploaded Source

Built Distribution

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

git_wizard-0.2.0-py3-none-any.whl (17.4 kB view details)

Uploaded Python 3

File details

Details for the file git_wizard-0.2.0.tar.gz.

File metadata

  • Download URL: git_wizard-0.2.0.tar.gz
  • Upload date:
  • Size: 16.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for git_wizard-0.2.0.tar.gz
Algorithm Hash digest
SHA256 ddba10e91862713d1d8c3988abf2418ab855486feeafc8acac0f1da0c1405e90
MD5 d3d73245f0763f3118fc97bb0fcb14d8
BLAKE2b-256 5fb54fecc92e6d344322c40686c3a8c995c5dc0fb7423478705d4bc959e070ec

See more details on using hashes here.

File details

Details for the file git_wizard-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: git_wizard-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 17.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for git_wizard-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c20c95cdc1379cdfda0541bfc8f1bc5509795a2630d7b1f970fd6daed8fb0d9a
MD5 159c5d13b6f2da6a1bc00f5f7ccaa77f
BLAKE2b-256 ff8e981fe3900c740c02d5dd92d639e4aaf078b6c7826b4d269b39e8cb7b3afe

See more details on using hashes here.

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