Drop-in git automation for any project. Enhanced commits, safe merges, validated pushes, branch sync — with optional Claude Code integration.
:: 1. Clone the repo (one-time)
git clone https://github.com/forkni/claude-git-workflow.git
:: 2. Run the installer — prompts for your project path
claude-git-workflow\install.cmd
:: 3. Done — use it (from your project, in Git Bash)
./scripts/git/commit_enhanced.sh "feat: your feature"install.cmd runs pre-install checks, copies scripts, runs configure.sh interactively, and cleans up temporary files.
# 1. Copy scripts, hook templates, and Claude Code integration into your project
cp -r claude-git-workflow/scripts/git/ your-project/scripts/git/
cp -r claude-git-workflow/hooks/ your-project/hooks/
cp -r claude-git-workflow/skill/ your-project/.claude/skills/auto-git-workflow/
cp claude-git-workflow/command/auto-git-workflow.md your-project/.claude/commands/
# 2. Auto-configure (scans project, generates config, installs hooks + skill)
cd your-project && ./scripts/git/configure.sh
# 3. Done — use it
./scripts/git/commit_enhanced.sh "feat: your feature"No manual config editing required for common setups. configure.sh auto-detects your branch names, lint tool, and local-only files.
| Script | Purpose |
|---|---|
configure.sh |
One-time setup — scans project, generates .cgw.conf, installs hooks |
commit_enhanced.sh |
Lint validation + local-only file protection + commit message format check |
merge_with_validation.sh |
Safe merge source→target: backup tag, auto-resolve DU/DD conflicts, stop on UU. --source/--target override the configured branch pair per-invocation. |
rollback_merge.sh |
Emergency rollback to pre-merge backup tag; --revert for safe history-preserving mode |
cherry_pick_commits.sh |
Cherry-pick with source branch validation and backup tag |
merge_docs.sh |
Documentation-only merge from source to target |
push_validated.sh |
Push with remote reachability check + force-push protection |
sync_branches.sh |
Sync local branches via fetch + rebase |
validate_branches.sh |
Check branch state before operations |
check_lint.sh |
Read-only lint validation |
fix_lint.sh |
Auto-fix lint issues |
create_pr.sh |
Create GitHub PR from source → target (triggers Charlie CI + GitHub Actions) |
install_hooks.sh |
Install git hooks (pre-commit + pre-push) |
setup_attributes.sh |
Generate .gitattributes for binary and text files (Python, TouchDesigner, GLSL, assets) |
clean_build.sh |
Safe cleanup of build artifacts with dry-run default (Python, TouchDesigner, GLSL) |
create_release.sh |
Create annotated version tags to trigger the GitHub Release workflow |
stash_work.sh |
Safe stash wrapper with untracked file support, named stashes, and logging |
repo_health.sh |
Repository health: integrity check, size report, large file detection, gc |
bisect_helper.sh |
Guided git bisect with backup tag, auto-detect good ref, automated test support |
rebase_safe.sh |
Safe rebase: backup tag, pushed-commit guard, abort/continue/skip, autostash |
branch_cleanup.sh |
Prune merged branches, stale remote-tracking refs, and old backup tags |
changelog_generate.sh |
Generate categorized markdown/text changelog from conventional commits |
undo_last.sh |
Undo last commit (keep staged), unstage files, discard changes, amend message |
Internal modules (not user-facing): _common.sh (shared utilities, sourced by every script), _config.sh (three-tier config resolution, sourced by _common.sh).
Scripts use a three-tier resolution system — environment variables override .cgw.conf, which overrides built-in defaults. Works out of the box without any config.
| Variable | Default | Description |
|---|---|---|
CGW_SOURCE_BRANCH |
development |
Branch where development happens |
CGW_TARGET_BRANCH |
main |
Stable/production branch |
CGW_REMOTE |
origin |
Remote name for fetch/push (use upstream for forks) |
CGW_LOCAL_FILES |
CLAUDE.md MEMORY.md .claude/ logs/ |
Files never committed |
CGW_LINT_CMD |
ruff |
Lint tool ("" to disable) |
CGW_MERGE_MODE |
direct |
direct (local merge) or pr (create GitHub PR) |
See docs/configuration.md for all options and language-specific lint examples (Python, JS, Go, Rust, C++).
| Guide | Contents |
|---|---|
| Installation | Detailed install steps, configure.sh options, troubleshooting |
| Usage | All script examples, commit format, branch setup, env vars |
| Configuration | Config system, all options, lint examples for 7 ecosystems |
| CI Setup | GitHub Actions, Charlie CI, local tool install |
| Claude Code | Skill install (local and global), slash command |
| Shell Style Audit | Google Shell Style Guide compliance report and fixes (v0.3.0) |
| cgw.conf.example | Inline-documented reference for every config variable |
- bash 4.0+
- git 2.0+
- For lint: ruff / flake8 / eslint / golangci-lint / clang-tidy / cppcheck / cargo (or none — set
CGW_LINT_CMD="") - For Claude Code integration: Claude Code CLI
- For PR creation (
create_pr.sh): gh CLI +gh auth login
Compatible with: Linux, macOS, Windows (Git Bash / WSL)
Windows installer (install.cmd) requires only Git for Windows — it validates bash availability as part of its pre-install checks.
MIT — see LICENSE