Skip to content

gitzy CLI Documentation

Welcome to the gitzy CLI documentation!

About

gitzy is a cross-platform command-line tool for managing and switching between multiple GitHub identities. It helps developers easily maintain separate work, personal, and alternate GitHub profiles, and switch between them with a single command. gitzy is open source, works on Windows, Linux, and macOS, and is designed for security, portability, and ease of use.

🚀 Quick Navigation

📥 Installation

  1. Go to the Releases page
  2. Download the appropriate binary for your platform:
Platform File to Download
Windows gitzy-windows-amd64.zip
Linux gitzy-linux-amd64.zip
macOS gitzy-darwin-amd64.zip
  1. Extract and install:

🪟 Windows

# Extract the ZIP file and run as Administrator:
install_windows.bat

🐧 Linux

wget https://github.com/gh0stfrk/gitzy/releases/latest/download/gitzy-linux-amd64.zip
unzip gitzy-linux-amd64.zip -d gitzy
cd gitzy
chmod +x install_linux.sh
./install_linux.sh

🍎 macOS

# Extract the ZIP file and run:
chmod +x install_linux.sh
./install_linux.sh

Option 2: Install with Go

go install github.com/gh0stfrk/gitzy@latest

Option 3: Build from Source

git clone https://github.com/gh0stfrk/gitzy.git
cd gitzy
make build

Verify Installation

gitzy --help

⚡ Quick Start

  1. Add a new profile: bash gitzy add work

  2. Switch to a profile: bash gitzy switch work

  3. List all profiles: bash gitzy list

  4. Remove a profile: bash gitzy wipe work

📚 Command Reference

🔧 Configuration

Storage Locations

  • Windows: %USERPROFILE%\.gitzy
  • Linux/macOS: ~/.gitzy (respects XDG_CONFIG_HOME if set)
  • Custom: Set GITZY_HOME environment variable

Security Notes

  • Tokens are stored unencrypted in the configuration directory
  • Follow GitHub token best practices
  • Consider using tokens with minimal required scopes

📖 For more details, see the README or view on GitHub.