gitbash 2.1.0 → 2.2.1

package/README.md

@@ -6,69 +6,97 @@ Pure bash, zero-dependency git utilities. Reduce repetitive typing and superchar
 
 ## Installation
 
-### Via npm
+Needs git >= 2.23 and bash >= 3.2. fzf (menus), delta (diffs) and bat (previews) are optional but recommended.
+
+### macOS
 
 ```bash
-npm i -g gitbash && gitbash --config
+npm i -g gitbash
+brew install fzf git-delta bat
+gitbash --config
 ```
 
-### Via install script (no npm or node needed)
+Shell integration (lets you type `commit` instead of `gitbash commit`):
 
 ```bash
-# curl
-curl -fsSL https://raw.githubusercontent.com/jaggli/gitbash/main/install.sh | sh
+## for bash
+echo 'eval "$(gitbash --init)"' >> ~/.bashrc
 
-# wget
-wget -qO- https://raw.githubusercontent.com/jaggli/gitbash/main/install.sh | sh
+## for zsh
+echo 'eval "$(gitbash --init)"' >> ~/.zshrc
 ```
 
-This downloads the latest GitHub release to `~/.local/share/gitbash` and links `~/.local/bin/gitbash`. Run `gitbash --update` (or the script again) to upgrade. Options are set as environment variables:
+### Linux
 
 ```bash
-# Install a specific version
-curl -fsSL https://raw.githubusercontent.com/jaggli/gitbash/main/install.sh | GITBASH_VERSION=2.0.1 sh
+npm i -g gitbash
+sudo apt install fzf git-delta bat   # Debian/Ubuntu, needs fzf >= 0.36
+gitbash --config
+```
+
+Shell integration:
 
-# Custom locations (e.g. system-wide)
-curl -fsSL https://raw.githubusercontent.com/jaggli/gitbash/main/install.sh \
-  | sudo GITBASH_INSTALL_DIR=/usr/local/share/gitbash GITBASH_BIN_DIR=/usr/local/bin sh
+```bash
+## for bash
+echo 'eval "$(gitbash --init)"' >> ~/.bashrc
+
+## for zsh
+echo 'eval "$(gitbash --init)"' >> ~/.zshrc
 ```
 
-To uninstall, remove `~/.local/share/gitbash` and `~/.local/bin/gitbash`.
+### Windows
 
-### Options
+Needs [Git for Windows](https://gitforwindows.org). In PowerShell or Git Bash; in WSL, follow the Linux steps:
 
-```bash
-gitbash --help         # Show help
-gitbash --version      # Show version
-gitbash --update       # Update to the latest release (npm or install script)
-gitbash --init         # Print shell functions (see Shell integration)
-gitbash --config       # Interactive configuration wizard
-gitbash --config-local # Configure overrides for the current repository (committed)
-gitbash --config-user  # Configure personal overrides for the current repository
+```powershell
+npm i -g gitbash
+winget install junegunn.fzf dandavison.delta sharkdp.bat   # needs fzf >= 0.54
+gitbash --config
 ```
 
-### Dependencies
+Shell integration for PowerShell. This creates your profile if needed, loads the functions in every new window, and allows local scripts to run (Windows PowerShell 5.1 blocks them by default):
 
-```bash
-# Required
-git >= 2.23, bash >= 3.2
+```powershell
+if (!(Test-Path $PROFILE)) { New-Item -Force $PROFILE }
+Add-Content $PROFILE 'gitbash --init --shell=pwsh | Out-String | Invoke-Expression'   # switch is a keyword: use gitbash switch
+Set-ExecutionPolicy -Scope CurrentUser RemoteSigned   # Windows PowerShell 5.1 only
+```
 
-# Optional (recommended)
-brew install fzf        # Interactive menus and previews (fzf >= 0.36)
-brew install git-delta  # Better diff highlighting
-brew install bat        # File preview with syntax highlighting
+Shell integration for Git Bash:
+
+```bash
+echo 'eval "$(gitbash --init)"' >> ~/.bashrc
 ```
 
-### Shell integration
+### Without npm
 
-Add to your `.zshrc` or `.bashrc` to call the commands without the `gitbash` prefix:
+Installation by script on machines without npm available
 
 ```bash
-eval "$(gitbash --init)"             # commit, switch, status, ...
-eval "$(gitbash --init --prefix=gb-)" # gb-commit, gb-switch, ... (avoids shadowing e.g. /usr/bin/pr)
+# macOS, Linux, Git Bash (or: wget -qO- ... | sh)
+curl -fsSL https://raw.githubusercontent.com/jaggli/gitbash/main/install.sh | sh
+```
+
+```powershell
+# Windows PowerShell (needs Git for Windows; prints the line for your $PROFILE)
+irm https://raw.githubusercontent.com/jaggli/gitbash/main/install.ps1 | iex
 ```
 
-This defines small wrapper functions; every command still runs in its own bash process, so nothing else is added to your shell. Individual aliases work too, e.g. `alias commit="gitbash commit"`.
+It installs to `~/.local/share/gitbash` and links `~/.local/bin/gitbash` (add that folder to your PATH if the script says so); delete both to uninstall. Set `GITBASH_VERSION` for a specific version, and `GITBASH_INSTALL_DIR` / `GITBASH_BIN_DIR` for other locations.
+
+## Options
+
+| Option | Description |
+| --- | --- |
+| `-h`, `--help` | Show the help |
+| `-v`, `--version` | Show the version |
+| `--update` | Update to the latest release (npm, pnpm or install script) |
+| `--init` | Print shell functions to call commands without the `gitbash` prefix |
+| `--init --prefix=gb-` | Prefixed functions: `gb-commit`, `gb-switch`, ... (avoids shadowing e.g. `/usr/bin/pr`) |
+| `--init --shell=pwsh` | PowerShell functions instead of bash/zsh |
+| `--config` | Configuration wizard (`~/.gitbashrc`); offers to install dependencies and the shell integration |
+| `--config-local` | Overrides for the current repository (`.gitbashrc`, committed) |
+| `--config-user` | Personal overrides for the current repository (`.gitbashrc-user`, not committed) |
 
 ## Commands
 

package/bin/gitbash

@@ -3,6 +3,8 @@
 
 # Resolve symlinks to get the actual script location
 SOURCE="${BASH_SOURCE[0]}"
+# Started from Windows with C:\...\bin\gitbash: dirname needs forward slashes
+[[ "$OSTYPE" == msys* || "$OSTYPE" == cygwin* ]] && SOURCE="${SOURCE//\\//}"
 while [[ -L "$SOURCE" ]]; do
     DIR="$(cd -P "$(dirname "$SOURCE")" && pwd)"
     SOURCE="$(readlink "$SOURCE")"
@@ -299,7 +301,17 @@ exclude_user_config() {
     print_info "Added .gitbashrc-user to $exclude"
 }
 
-# Report missing optional dependencies and offer to install them with Homebrew
+# winget package id of a dependency
+winget_id() {
+    case "$1" in
+        fzf) echo "junegunn.fzf" ;;
+        git-delta) echo "dandavison.delta" ;;
+        bat) echo "sharkdp.bat" ;;
+    esac
+}
+
+# Report missing optional dependencies and offer to install them with
+# Homebrew, or winget on Windows
 check_dependencies() {
     local missing=() dep
     command -v fzf >/dev/null 2>&1 || missing+=("fzf")
@@ -316,24 +328,47 @@ check_dependencies() {
 
     echo "Missing optional dependencies: ${missing[*]}"
     echo "  fzf (>= $GB_FZF_MIN_VERSION) - interactive menus, git-delta - diff highlighting, bat - file previews"
-    if ! command -v brew >/dev/null 2>&1; then
-        echo "Install them with your package manager, e.g.: sudo apt install ${missing[*]}"
+    local -a install
+    local manager
+    if gb_is_windows; then
+        manager="winget"
+        install=(winget install --exact --id)
+    else
+        manager="Homebrew"
+        install=(brew install)
+    fi
+    if ! command -v "${install[0]}" >/dev/null 2>&1; then
+        if gb_is_windows; then
+            echo "Install them with a package manager, e.g.: scoop install ${missing[*]/git-delta/delta}"
+        else
+            echo "Install them with your package manager, e.g.: sudo apt install ${missing[*]}"
+        fi
         return 0
     fi
-    if gb_confirm "Install them with Homebrew?" y; then
+    local package
+    if gb_confirm "Install them with $manager?" y; then
         for dep in "${missing[@]}"; do
-            if brew install "$dep"; then
+            package="$dep"
+            gb_is_windows && package=$(winget_id "$dep")
+            if "${install[@]}" "$package"; then
                 print_success "$dep installed"
             else
                 print_error "Failed to install $dep"
             fi
         done
+        gb_is_windows && print_info "Open a new terminal to pick up the installed programs."
     fi
 }
 
 # Offer to add the shell integration to the rc file of the user's shell
 check_shell_integration() {
     local shell_name shell_rc
+    # Can't tell PowerShell from Git Bash here: always show the PowerShell line
+    if gb_is_windows; then
+        echo
+        print_info "For PowerShell, add this line to your \$PROFILE:"
+        echo "  gitbash --init --shell=pwsh | Out-String | Invoke-Expression"
+    fi
     shell_name=$(basename "${SHELL:-}")
     case "$shell_name" in
         zsh) shell_rc="$HOME/.zshrc" ;;
@@ -345,8 +380,10 @@ check_shell_integration() {
             fi
             ;;
         *)
-            echo
-            print_info "Shell '$shell_name' is not supported for integration. Use 'gitbash <command>' or aliases."
+            if ! gb_is_windows; then
+                echo
+                print_info "Shell '$shell_name' is not supported for integration. Use 'gitbash <command>' or aliases."
+            fi
             return 0
             ;;
     esac
@@ -402,7 +439,7 @@ show_help() {
 Usage:
     gitbash <command> [args...]
     gitbash --help | --version | --update
-    gitbash --init [--prefix=PREFIX]
+    gitbash --init [--prefix=PREFIX] [--shell=pwsh]
     gitbash --config | --config-local | --config-user
 
 Commands:
@@ -428,7 +465,8 @@ Options:
   -v, --version    Show version number
   --update         Update gitbash to the latest release
   --init           Print shell functions for calling commands directly
-                   (--prefix=gb- creates gb-commit, gb-switch, ...)
+                   (--prefix=gb- creates gb-commit, gb-switch, ...;
+                   --shell=pwsh prints PowerShell functions)
   --config         Configure gitbash and save to ~/.gitbashrc
   --config-local   Configure overrides for this repository (.gitbashrc, committed)
   --config-user    Configure personal overrides for this repository (.gitbashrc-user)
@@ -441,6 +479,7 @@ Examples:
 Shell Integration:
   Add to your .zshrc or .bashrc:
     eval "\$(gitbash --init)"
+  PowerShell: see 'gitbash --init --shell=pwsh'
 
   This enables calling commands directly:
     commit fix bug -p
@@ -456,10 +495,12 @@ EOF
 # Print wrapper functions for the interactive shell. Commands still run in
 # their own bash process, so nothing leaks into the user's shell.
 show_init() {
-    local prefix="" arg cmd bin_quoted
+    local prefix="" shell="sh" arg cmd bin_quoted
     for arg in "$@"; do
         case "$arg" in
             --prefix=*) prefix="${arg#--prefix=}" ;;
+            --shell=bash|--shell=zsh|--shell=sh) shell="sh" ;;
+            --shell=pwsh|--shell=powershell) shell="pwsh" ;;
             *) print_error "Unknown option for --init: $arg"; return 1 ;;
         esac
     done
@@ -467,6 +508,10 @@ show_init() {
         print_error "Invalid prefix '$prefix' (use letters, digits, '-' or '_')."
         return 1
     fi
+    if [[ "$shell" == "pwsh" ]]; then
+        show_init_pwsh "$prefix"
+        return
+    fi
     printf -v bin_quoted '%q' "$GITBASH_BIN"
     echo "# gitbash shell integration - add to your .zshrc or .bashrc:"
     echo "#   eval \"\$(gitbash --init${prefix:+ --prefix=$prefix})\""
@@ -475,6 +520,49 @@ show_init() {
     done
 }
 
+# Single-quoted PowerShell string
+pwsh_quote() {
+    local q="'"
+    printf "'%s'" "${1//$q/$q$q}"
+}
+
+# The bash that PowerShell functions run gitbash with. On Windows, Git's
+# bin\bash.exe: it puts git and the Unix tools on PATH, unlike usr\bin\bash.exe.
+pwsh_bash() {
+    local bash_path git_root
+    bash_path=$(command -v bash)
+    if gb_is_windows && command -v cygpath >/dev/null 2>&1; then
+        git_root=$(cygpath -w /)
+        git_root="${git_root%\\}"
+        if [[ -f "$git_root\\bin\\bash.exe" ]]; then
+            printf '%s\n' "$git_root\\bin\\bash.exe"
+        else
+            cygpath -w "$bash_path"
+        fi
+    else
+        echo "$bash_path"
+    fi
+}
+
+# Functions for PowerShell ($PROFILE), running gitbash with bash
+show_init_pwsh() {
+    local prefix="$1" bash_q bin_q cmd bin="$GITBASH_BIN"
+    gb_is_windows && command -v cygpath >/dev/null 2>&1 && bin=$(cygpath -m "$bin")
+    bash_q=$(pwsh_quote "$(pwsh_bash)")
+    bin_q=$(pwsh_quote "$bin")
+    echo "# gitbash shell integration for PowerShell - add to your \$PROFILE:"
+    echo "#   gitbash --init --shell=pwsh${prefix:+ --prefix=$prefix} | Out-String | Invoke-Expression"
+    echo "function gitbash { & $bash_q $bin_q @args }"
+    for cmd in "${COMMANDS[@]}"; do
+        # 'switch' is a PowerShell keyword: a function by that name can't be called
+        if [[ -z "$prefix" && "$cmd" == "switch" ]]; then
+            echo "# switch is a PowerShell keyword: use 'gitbash switch', or --prefix (e.g. gb-switch)"
+            continue
+        fi
+        echo "function ${prefix}${cmd} { & $bash_q $bin_q $cmd @args }"
+    done
+}
+
 # =============================================================================
 # Main entry point
 # =============================================================================

package/bin/gitbash.js

@@ -0,0 +1,97 @@
+#!/usr/bin/env node
+// npm entry point: runs bin/gitbash with bash.
+// On Windows, npm's own launchers would run the first bash on PATH, which is
+// often WSL's (C:\Windows\System32\bash.exe): use Git for Windows' bash instead.
+'use strict';
+
+var childProcess = require('child_process');
+var fs = require('fs');
+var path = require('path');
+
+// Forward slashes: bash's dirname doesn't split C:\...\bin\gitbash
+var script = path.join(__dirname, 'gitbash').replace(/\\/g, '/');
+
+function isFile(file) {
+    try {
+        return fs.statSync(file).isFile();
+    } catch (e) {
+        return false;
+    }
+}
+
+// <Git>\bin\bash.exe: it puts git and the Unix tools on PATH, unlike usr\bin\bash.exe
+function bashIn(root) {
+    var bash = root && path.join(root, 'bin', 'bash.exe');
+    return bash && isFile(bash) ? bash : null;
+}
+
+function gitForWindowsBash() {
+    var dirs = (process.env.PATH || '').split(path.delimiter);
+    var i, dir, bash;
+    // git.exe is in <Git>\cmd, <Git>\bin or <Git>\mingw64\bin
+    for (i = 0; i < dirs.length; i++) {
+        dir = dirs[i].replace(/^"|"$/g, '');
+        if (dir && isFile(path.join(dir, 'git.exe'))) {
+            bash = bashIn(path.dirname(dir)) || bashIn(path.dirname(path.dirname(dir)));
+            if (bash) return bash;
+        }
+    }
+    var keys = ['HKLM\\SOFTWARE\\GitForWindows', 'HKCU\\SOFTWARE\\GitForWindows'];
+    for (i = 0; i < keys.length; i++) {
+        var out = childProcess.spawnSync('reg', ['query', keys[i], '/v', 'InstallPath'], { encoding: 'utf8' });
+        var match = /InstallPath\s+REG_SZ\s+(.+)/.exec(out.stdout || '');
+        bash = match && bashIn(match[1].trim());
+        if (bash) return bash;
+    }
+    var roots = [
+        process.env.ProgramFiles && path.join(process.env.ProgramFiles, 'Git'),
+        process.env.LOCALAPPDATA && path.join(process.env.LOCALAPPDATA, 'Programs', 'Git')
+    ];
+    for (i = 0; i < roots.length; i++) {
+        bash = bashIn(roots[i]);
+        if (bash) return bash;
+    }
+    return null;
+}
+
+var bash = 'bash';
+if (process.platform === 'win32') {
+    bash = gitForWindowsBash();
+    if (!bash) {
+        process.stderr.write('gitbash needs Git for Windows. Install it with: winget install Git.Git\n');
+        process.exit(1);
+    }
+}
+
+var child = childProcess.spawn(bash, [script].concat(process.argv.slice(2)), { stdio: 'inherit' });
+
+// Ctrl-C (SIGINT, SIGQUIT) reaches bash and fzf directly from the terminal: wait
+// for them instead of exiting first. SIGTERM and SIGHUP are passed on.
+var handlers = {};
+['SIGINT', 'SIGQUIT', 'SIGTERM', 'SIGHUP'].forEach(function (signal) {
+    handlers[signal] = signal === 'SIGTERM' || signal === 'SIGHUP'
+        ? function () { child.kill(signal); }
+        : function () {};
+    try {
+        process.on(signal, handlers[signal]);
+    } catch (e) {
+        // Not supported on this platform
+    }
+});
+
+child.on('error', function (err) {
+    process.stderr.write('gitbash: could not run ' + bash + ': ' + err.message + '\n');
+    process.exit(1);
+});
+
+child.on('exit', function (code, signal) {
+    if (signal) {
+        // Exit the same way bash did
+        Object.keys(handlers).forEach(function (s) {
+            process.removeListener(s, handlers[s]);
+        });
+        process.kill(process.pid, signal);
+        return;
+    }
+    process.exit(code === null ? 1 : code);
+});

package/commands/_self_update.sh

@@ -18,6 +18,10 @@ _gb_global_package_dir() {
     local root
     root=$("$1" root -g 2>/dev/null) || return 1
     [[ -n "$root" ]] || return 1
+    # Windows: C:\Users\...\npm\node_modules
+    if gb_is_windows && command -v cygpath >/dev/null 2>&1; then
+        root=$(cygpath -u "$root") || return 1
+    fi
     (cd -P "$root/gitbash" 2>/dev/null && pwd)
 }
 

package/commands/_utils.sh

@@ -9,7 +9,29 @@ if [[ -n "${_GB_UTILS_LOADED:-}" ]]; then
 fi
 _GB_UTILS_LOADED=1
 
-GB_FZF_MIN_VERSION="0.36.0"
+# =============================================================================
+# Platform
+# =============================================================================
+
+# Git Bash (MSYS2) or Cygwin on Windows
+gb_is_windows() {
+    case "${OSTYPE:-}" in
+        msys*|cygwin*) return 0 ;;
+    esac
+    return 1
+}
+
+# Linux in WSL
+_gb_is_wsl() {
+    [[ -n "${WSL_DISTRO_NAME:-}" || -n "${WSL_INTEROP:-}" ]]
+}
+
+# On Windows, fzf runs previews with bash and quotes {} for it since 0.54
+if gb_is_windows; then
+    GB_FZF_MIN_VERSION="0.54.0"
+else
+    GB_FZF_MIN_VERSION="0.36.0"
+fi
 
 # =============================================================================
 # Output
@@ -286,7 +308,11 @@ _gb_version_ge() {
 # Check that fzf is installed and recent enough
 require_fzf() {
     if ! command -v fzf >/dev/null 2>&1; then
-        print_error "fzf is not installed. Install it with 'brew install fzf' (macOS) or 'sudo apt install fzf' (Debian/Ubuntu)."
+        if gb_is_windows; then
+            print_error "fzf is not installed. Install it with 'winget install junegunn.fzf'."
+        else
+            print_error "fzf is not installed. Install it with 'brew install fzf' (macOS) or 'sudo apt install fzf' (Debian/Ubuntu)."
+        fi
         return 1
     fi
     local version
@@ -632,7 +658,14 @@ gb_web_url() {
 # Open a URL in the browser, or print it if no opener is available
 gb_open_url() {
     local url="$1"
-    if command -v open >/dev/null 2>&1 && [[ "$(uname -s)" == "Darwin" ]]; then
+    if gb_is_windows && command -v rundll32 >/dev/null 2>&1; then
+        # Not cmd's start: it would need & and ^ in the URL escaped
+        rundll32 url.dll,FileProtocolHandler "$url"
+    elif _gb_is_wsl && command -v wslview >/dev/null 2>&1; then
+        wslview "$url"
+    elif _gb_is_wsl && command -v rundll32.exe >/dev/null 2>&1; then
+        rundll32.exe url.dll,FileProtocolHandler "$url"
+    elif command -v open >/dev/null 2>&1 && [[ "$(uname -s)" == "Darwin" ]]; then
         open "$url"
     elif command -v xdg-open >/dev/null 2>&1; then
         xdg-open "$url" >/dev/null 2>&1

package/commands/pr.sh

@@ -59,7 +59,7 @@ Behavior:
       Bitbucket                    <repo>/pull-requests/new?source=<branch>
       Azure DevOps                 <repo>/pullrequestcreate?sourceRef=<branch>
   - Works with SSH and HTTPS remotes; credentials in the remote URL are never used
-  - Opens the browser with 'open' (macOS) or 'xdg-open' (Linux), otherwise prints the URL
+  - Opens the browser (macOS, Linux, WSL, Git Bash on Windows), otherwise prints the URL
 
 Examples:
   $ pr

package/commands/repo.sh

@@ -31,7 +31,7 @@ Behavior:
   - Otherwise opens the URL derived from the remote
     (GitHub, GitHub Enterprise, GitLab, Bitbucket, Azure DevOps)
   - Works with SSH and HTTPS remotes; credentials in the remote URL are never used
-  - Opens the browser with 'open' (macOS) or 'xdg-open' (Linux), otherwise prints the URL
+  - Opens the browser (macOS, Linux, WSL, Git Bash on Windows), otherwise prints the URL
 
 Examples:
   $ repo

package/docs/CONTRIBUTING.md

@@ -125,7 +125,7 @@ shellcheck -x bin/gitbash commands/*.sh
 
 Tests live in `test/*.bats`. Each test gets its own temporary repository with a local bare remote (`test/helpers/setup.bash`). fzf is replaced by a stub that records its arguments and answers from a plan (`test/helpers/bin/fzf`); `test/fzf_real.bats` drives the real fzf in a pseudo-terminal. Add a test for every bug fix.
 
-CI runs shellcheck and the tests on Ubuntu (bash 5) and macOS (bash 3.2 and 5).
+CI runs shellcheck and the tests on Ubuntu (bash 5), macOS (bash 3.2 and 5) and Windows (Git Bash). Scripts must keep LF line endings (`.gitattributes` enforces it).
 
 ### Code style:
 - Follow existing bash script conventions; scripts must work with bash 3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gitbash",
-  "version": "2.1.0",
+  "version": "2.2.1",
   "description": "Opinionated git utilities for bash with fzf-powered menus",
   "author": "jaggli",
   "license": "MIT",
@@ -24,7 +24,7 @@
     "stash"
   ],
   "bin": {
-    "gitbash": "bin/gitbash"
+    "gitbash": "bin/gitbash.js"
   },
   "files": [
     "bin/",
@@ -35,7 +35,8 @@
   ],
   "os": [
     "darwin",
-    "linux"
+    "linux",
+    "win32"
   ],
   "engines": {
     "node": ">=14"