Skip to content

Latest commit

 

History

History
39 lines (31 loc) · 2.15 KB

File metadata and controls

39 lines (31 loc) · 2.15 KB

GX Documentation

GX is a smart Git CLI with interactive pickers, a workspace (git worktree) manager, a pull-request dashboard, and shell integration.

New to gx? Start with Getting Started.

Contents

Guide What's inside
Getting Started Installation, prerequisites, shell integration, and a first workflow.
Core Commands Everyday Git, made interactive: checkout, status, add, commit, push, stash, log, and git pass-through.
Workspaces Manage git worktrees: create, switch, update, sync setup files, and clean up stale workspaces and branches.
Pull Requests The interactive PR dashboard: review-state grouping, quick actions, reviewer suggestions.
Repo Onboarding Make new workspaces reproducible with shared (.gx/workspace.toml) or personal setup, including pre/post-create hooks.
Shell Integration gx setup: aliases, the cd-on-switch wrapper, and completions for zsh, bash, and fish.
Configuration The ~/.config/gx/config.toml reference: AI, workspace, and PR-dashboard settings.
Agent Skills Ship gx as a guide rail for autonomous AI coding agents.

Command reference at a glance

Command Aliases Documentation
checkout co, switch Core Commands → Checkout
status s Core Commands → Status
add a Core Commands → Add
commit c Core Commands → Commit
push p Core Commands → Push
stash st Core Commands → Stash
log l Core Commands → Log
workspace ws Workspaces
pr prs, pullrequest, pullrequests Pull Requests
onboarding onboard Repo Onboarding
setup Shell Integration

← Back to the project README