gst

Synposis

gst is short for Git Status - it's a commandline app with some neat features for improving your workflow with git Note that gst is meant for in dark themed terminals

Installation

Install from pip.

pip install gst

Usage

$ gst              # View git status

$ gst 1            # Get file path by reference

$ gst -a 0         # Add files to staging area

$ gst -r 0         # Reset staged changes

$ gst -c 1         # Checkout files to revert changes

$ gst -D 2         # Delete files at index

$ gst -d 1         # View file differences

$ gst -e 1         # Open file in editor

# Use file references with other commands
$ cat $(gst 1)     # Display contents of file at index 1
$ vim $(gst 1)     # Open file at index 1 in vim

Range and selection syntax

All commands that accept REF_RANGE support flexible selection patterns:

Contributing

Contributions are welcome! See CONTRIBUTING.md for development setup, testing guidelines, and how to contribute to the project.

Compatibility

• Linux, Mac, Windows
• Git version >=2
• Python 3.8+ (fully tested and supported)
• Python 3.6, 3.7 (best-effort support with manual testing)

Python Version Support Policy

• Python 3.8+: Fully supported with automated testing in CI/CD
• Python 3.6, 3.7: Best-effort support with periodic manual testing for compatibility

Due to GitHub Actions dropping support for Python 3.6 and 3.7, we can no longer provide automated testing for these versions. However, we will continue to maintain compatibility when possible and provide periodic updates with manual testing to confirm functionality.

Performance Optimization

Since gst relies on git status, optimizing git performance will directly improve gst performance. These settings can provide 50-75% faster operations for large repositories:

# Enable all git performance optimizations
git config core.fsmonitor true          # File system monitor (Windows/macOS only)
git config core.untrackedCache true     # Cache untracked file detection
git config feature.manyFiles true       # Optimize for large repositories

Features:

• FSMonitor: Background file monitoring, up to 75% faster (not supported on Linux)
• Untracked Cache: Faster detection of untracked files
• feature.manyFiles: Optimized index format for repositories with many files

Note: FSMonitor provides the biggest performance boost for large repositories but may add overhead for small repositories.