@lukasmoeller/git-kit
v2.1.0
Published
A modular Git alias distribution toolkit.
Downloads
238
Readme
git-kit
A modular Git alias distribution toolkit. Installs a curated set of Git aliases via a managed include file — without touching your existing configuration.
Features
- Installs Git aliases through a managed include file, not by overwriting your config
- Supports profiles (
minimal,lazy,power) for different alias sets - Switching profiles or targets automatically replaces the previous include — only one git-kit include is ever active at a time
- Safe uninstall that only removes the
git-kit-managed include;--allcleans up everything at once - Cross-platform: macOS, Linux, and Windows
Requirements
Installation
npm install -g @lukasmoeller/git-kitUsage
Install aliases
Install the full alias set:
git-kit installInstall a specific profile:
git-kit install --profile minimal
git-kit install --profile lazy
git-kit install --profile powerList aliases
List all available aliases:
git-kit listList aliases for a specific profile:
git-kit list --profile powerList profiles
git-kit profilesUpdate aliases
Update the managed alias file with the latest aliases:
git-kit updateUpdate a specific profile:
git-kit update --profile powerCheck installation
git-kit doctorCheck a specific profile:
git-kit doctor --profile minimalUninstall
Uninstall all managed aliases:
git-kit uninstallUninstall a specific profile:
git-kit uninstall --profile minimalRemove all git-kit-managed includes and every managed file at once:
git-kit uninstall --allGenerate configs and docs
Regenerate the managed alias config files and documentation from the source alias definitions:
git-kit generateThis is primarily a development/maintainer command. Run it after modifying files in
aliases/.
Configuration
git-kit writes a managed alias config file and adds a single [include] entry to your global Git config. Your existing aliases are not modified.
Managed files are stored at:
- macOS/Linux:
~/.config/git-kit - Windows:
%APPDATA%\git-kit
Profiles
| Profile | Description |
| --- | --- |
| minimal | Essential day-to-day aliases only |
| lazy | Comfortable aliases for everyday development |
| power | Full alias set for power users |
See docs/aliases.md for the complete alias reference.
Development
Install dependencies:
bun installGenerate alias configs and docs:
bun run generateRun tests:
bun testBuild:
bun run buildValidate generated files are up to date:
bun run validate
License
MIT
