Skip to content

bymehul/ghk

Repository files navigation

ghk

Simple GitHub helper — push code without the complexity.

Release License

📖 Documentation · ⬇️ Download


Install

No Rust required — download and run!

# Linux/macOS (recommended)
curl -sSL https://raw.githubusercontent.com/bymehul/ghk/main/install.sh | bash

# Debian/Ubuntu
wget https://github.com/bymehul/ghk/releases/latest/download/ghk_1.0.0_amd64.deb
sudo dpkg -i ghk_*.deb

# Fedora/RHEL
sudo rpm -i https://github.com/bymehul/ghk/releases/latest/download/ghk-1.0.0-1.x86_64.rpm

# Windows (PowerShell)
irm https://raw.githubusercontent.com/bymehul/ghk/main/install.ps1 | iex

# From source (requires Rust)
cargo install --git https://github.com/bymehul/ghk

See INSTALL.md for detailed instructions.

Quick Start

ghk setup      # Install git & gh if missing
ghk init       # Start tracking project
ghk create     # Create repo on GitHub
ghk push       # Save changes

Commands

Command Alias Purpose Runs...
setup Install requirements (Checks requirements)
init Start tracking folder git init
login / logout GitHub auth gh auth login
create Create repo on GitHub gh repo create
push save Save changes git add -A && git commit && git push
pull sync Download changes git pull
clone <repo> download Download repo gh repo clone
status Show status git status
diff Preview changes git diff
history log Show recent saves git log
undo Undo last commit git reset --soft HEAD~1
open Open in browser gh browse
branch List/switch branches git branch
ignore Add .gitignore (Writes .gitignore)
license Add license file (Writes LICENSE)
config View/edit settings (Edits config)
user list/switch Manage accounts (Internal auth)
completions Shell completions (Generates script)

Options

Flag Effect
-q, --quiet Suppress output
--nocolor Disable colors
-h, --help Show help
-V, --version Show version

Shell Completions

# Bash
ghk completions bash >> ~/.bashrc

# Zsh  
ghk completions zsh > ~/.zfunc/_ghk

# Fish
ghk completions fish > ~/.config/fish/completions/ghk.fish

Philosophy

  • No jargon — "save" not "commit"
  • One command, one thing
  • Always asks before destructive actions
  • Works everywhere — Linux, macOS, Windows

License

MIT