GAlias CLI (0.49.0)

GAlias CLI provides a command-line interface to replicate the Git aliases defined in this package.
This allows them to be run both as a Python package (installed as g or galias) and directly using uvx.
This is a companion script for the useReq/req 🤖✨.

Quick Start | Feature Highlights | Upgrading or Removing | CLI Examples

🚧 DRAFT: Proof-of-Concept (PoC) Version 📝 - Work in Progress 🏗️ 🚧
⚠️ IMPORTANT NOTICE: Created with PI-useReq/pi-usereq 🤖✨ ⚠️

Feature Highlights

• Supports Conventional Commit Standards compatible with release-changelog-builder-action.

• Auto-amending wip command for day-to-day "work in progress" commits.

• Common aliases for repetitive tasks like add --all (aa) and more.

• Acts like a .gitconfig [alias] section, providing all standard Git commands with a fallback mechanism.

• Customizable three-branch workflow: master, develop, and work.

• Conventional commit aliases support <module>: <description> syntax (example: g new api: add endpoint) and also accept <description> only, using .galias.conf.default_commit_module (default: empty, so messages become <type>: <description> when no module is configured).

• Standardized commits with specific commands like: g new core: foo bar. Use these commands for common activities such as:

  • new: Implement new features.
  • implement: Implement features or larger changes.
  • refactor: Refactor existing code without changing behavior.
  • fix: Bug fixes.
  • change: Software changes.
  • docs: Add/modify documentation.
  • style: Styling modifications.
  • revert: Revert changes.
  • rollback: Restore branch content to a previous commit/tag by creating a dedicated rollback revert commit. Runs a version pre-check first and preserves the current application version by restoring it via chver before the rollback commit.
  • misc: Miscellaneous tasks.
  • cover: Add/adjust tests to improve coverage.

• Provides major, minor, and patch release commands that auto-generate a CHANGELOG.md, create a tag on configured master; the --dev/--develop option limits any release to configured develop.

  Command	Branch	Changelog Type
  patch --dev	work -> develop	Include patch versions
  patch	work -> develop -> master	Include patch versions
  minor	work -> develop -> master	Minor versions only
  major	work -> develop -> master	Minor versions only

• Provides backup command to run release preflight checks, merge work into develop, push develop, and return to work.

• Provides get command to fast-forward local master and develop from origin (with tags), then fast-forward merge develop into work after strict preflight checks.

• Provides str command to print all remotes and run git remote show <remote> for each.

• Provides visual diff aliases for repository comparisons: dwc (working tree vs HEAD), dcc (HEAD~1 vs HEAD), dccc (HEAD~2 vs HEAD), dwcc (working tree vs HEAD~1), dw <ref> (working tree vs a specific ref), dc <ref_a> <ref_b> (between two refs), plus configured-branch comparisons dcd (develop vs work), dcm (master vs work), and ddm (master vs develop).

• Provides worktree aliases: wt (generic git worktree subcommands with arguments forwarded unchanged), wtl (dedicated git worktree list with -v/--porcelain/-z forwarding), wtp (git worktree prune ...), and wtd (worktree delete with paired branch cleanup and optional --force).

• Provides file listing aliases: ls lists tracked files; lsa lists untracked files; lsi lists ignored/untracked files and applies a default directory/suffix filter unless --include-all is provided.

• Provides an overview alias: o prints a structured repository summary with working-tree status, branch divergence/alignment sections, and a branch table that lists configured branches first and then all other local/remote branches with latest commit subjects.

• Version management commands: ver checks version consistency (supports --verbose/--debug), chver <major.minor.patch> updates files matched by ver_rules, and changelog generates CHANGELOG.md (supports --include-patch, --force-write, --print-only, --disable-history).

• Self-upgrade and self-uninstall management commands are Linux-only for local execution (--upgrade, --uninstall), with manual command hints on other platforms.

• Includes a quick overview command o:

• Includes git-foresta command l: Options include --all, --no-color, --no-status, --reverse, --wrap, --abbrev=<n>, --svdepth=<n>, --style=<n>, --graph-margin-left=<n>, --graph-margin-right=<n>, and --graph-symbol-* overrides.

Requirements

• Astral uv tool is required for project execution (uv tool, uvx, and uv run flows).
• A separate external or system-managed Python virtual environment is not required.
• When needed, you can generate a transient requirements.txt file with:

  uv export --format requirements-txt > requirements.txt
  

Quick Start

Prerequisites

• Supported runtime for the CLI: Linux, macOS, or Windows (with Git + Python 3.11+ available).
• --upgrade installs from PyPI by default (--github installs from GitHub) and --uninstall executes locally only on Linux; other platforms print the equivalent manual uv tool command.
• Install the uv tool from: https://docs.astral.sh/uv/getting-started/installation/

Install GAlias

• Primary Method: Astral uv (from PyPI)

uv tool install galias

• Alternative Method: uvx, run directly without installation (from PyPI)

uvx galias <command> [args...]

• Install from GitHub (intermediate and test releases)

uv tool install --force --from git+https://github.com/Ogekuri/GAlias galias

Upgrade to the latest version published on GitHub:

g --upgrade --github

• Run with the Repository-Local Launcher (no installation required)

scripts/g.sh <command> [args...]

Requires Astral uv in PATH: the launcher resolves the repository root and delegates execution to uv run --project <repo> python -m git_alias.

Create Configuration Files (.galias.conf + $HOME/.config/galias/config.json)

g --write-config

Edit Configuration Files

• Customize repository-local .galias.conf with master, develop, work, default_commit_module, and ver_rules.
• Each ver_rules entry pairs a pattern (file selector) with a regex (version extractor).
• ver_rules.pattern uses the .gitignore file syntax (gitignore(5)). Only tracked repository files (git ls-files) are candidates, and hardcoded cache/temporary paths (e.g. .git, tmp, temp, .cache, .pytest_cache) are always excluded from matching. Semantics:
  • Patterns without / match at any depth; patterns containing / are anchored to the repository root (a leading ./ is stripped).
  • A backslash escapes the next character and is never treated as a path separator (e.g. \!file.txt matches a file literally named !file.txt).
  • A pattern starting with ! is a negation rule: matching files are excluded from every ver_rules match list; negation entries do not need a regex and are not evaluated for version detection.
  • A pattern that matches zero repository files aborts ver and chver with an explicit error.

Pattern examples (ver_rules.pattern, gitignore syntax):

The default ver_rules select README.md, src/**/*.py, and pyproject.toml.

• Customize global $HOME/.config/galias/config.json with edit_command, gp_command, and gr_command.
• Running g --write-config normalizes both files to these key sets and migrates legacy global editor to edit_command.

Work-in-Progress Commits

g st
g wip

g wip auto-stages tracked/untracked working-tree changes when the index is empty.

Override a wip Commit with a Final Commit

g new core: finalize release notes

Release a New Version (with all changes committed)

When your work branch is fully committed, release a new version with:

g minor

The command must run from the work branch with a clean working tree; it bumps versions per ver_rules, creates a temporary local annotated v<next> tag only for changelog generation, deletes that temporary tag after changelog generation, and creates the definitive tag immediately before push (--dev/--develop: on develop, then an atomic push of develop with the release tag only; default: on master, then an atomic push of master with the release tag after pushing develop).

Management Commands

Upgrade or uninstall the GAlias CLI:

• g --upgrade / galias --upgrade: Reinstalls the tool from PyPI on Linux; g --upgrade --github reinstalls from the GitHub repository; on non-Linux platforms it prints the equivalent manual command.
• g --uninstall / galias --uninstall: Uninstalls the tool on Linux; on non-Linux platforms it prints the equivalent manual command.
• g --write-config / galias --write-config: Inserts missing defaults into repository .galias.conf and global $HOME/.config/galias/config.json.
• g --ver / g --version / galias --ver / galias --version: Prints the CLI version and the latest versions available on PyPI and GitHub.
• g --help / galias --help: Prints management commands, configuration parameters, and the alias list; use g --help <command> for a single command.

README Maintenance Policy

When a CLI command is added, modified, or removed, this README is updated to reflect user-facing usage changes. Internal logic-only refactoring that does not change command behavior does not require README updates.

CLI Examples

Some CLI examples:

• g: Prints Please provide a command or --help and Usage: g <command> [options].
• g --help / galias --help: Prints management commands, configuration parameters, and the alias list; use g --help <command> for a single command.
• g lg --help: Shows the help text for the lg alias.
• g cm "Message": Runs git commit with the provided message.
• g new api: add endpoint: Creates new(api): Add endpoint. (first letter normalized to uppercase and a trailing period added when missing).
• g new add endpoint: Creates new: Add endpoint. when .galias.conf.default_commit_module is empty.
• g wip: Auto-stages when needed and commits wip: work in progress..
• g backup: Merges configured work into develop, pushes develop, and checks out back to work.
• g get: Fast-forwards local master and develop from origin and then fast-forward merges develop into work.
• g str: Lists remotes and prints git remote show details for each.
• g rollback v1.2.3: Reverts commits after v1.2.3 and creates revert: Roll back branch to v1.2.3 (<hash>).; the application version detected before the rollback is preserved and restored via chver inside the rollback commit.
• g dcd: Runs git difftool -d <develop> <work> using configured branch names.
• g dcm: Runs git difftool -d <master> <work> using configured branch names.
• g ddm: Runs git difftool -d <master> <develop> using configured branch names.
• g bd --force feature/demo: Removes the associated worktree first when present, then force-deletes feature/demo.
• g wt list: Runs git worktree list; wt forwards any git worktree subcommand/argument (e.g. g wt add <path> <branch>) unchanged.
• g wtl --porcelain: Lists worktrees via git worktree list --porcelain; g wtp runs git worktree prune.
• g wtd --force ../repo-worktree: Force-removes the target worktree; when it is associated to a local branch, the worktree is deleted before the branch.
• g ls -z: Lists tracked files using git ls-files --exclude-standard.
• g lsi -z: Lists ignored/untracked files using git ls-files --others --ignored --exclude-standard plus the default filter.
• g lsi --include-all -z: Lists all ignored/untracked files without the default filter.
• g o: Prints a verbose overview with status, branch distances, active worktrees, and a qualitative ASCII topology tree.
• g ver --verbose: Verifies version consistency with detailed output.
• g chver 1.2.3: Updates the project version to 1.2.3 using ver_rules.
• g changelog --print-only: Prints the generated changelog without writing CHANGELOG.md.

Acknowledgments

Special thanks to Jan Engelhardt and Takaaki Kasai, authors of the Perl git-foresta program, integrated in G.