gitui

GitUI vous offre le confort d'une interface graphique git mais directement dans votre terminal

Table des matières

1. Caractéristiques
2. Motivation
3. Repères
4. Feuille de route
5. Limites
6. Installation
7. Construire
8. FAQ
9. Diagnostic
10. Thème de couleur
11. Raccourcis de touches
12. Parrainage
13. Inspiration
14. Contribuer
15. Contributeurs

1. Caractéristiques ^{Haut ▲}

• Contrôle rapide et intuitif au clavier uniquement
• Aide contextuelle ( pas besoin de mémoriser des tonnes de raccourcis clavier)
• Inspecter, valider et modifier les modifications (y compris les hooks : pre-commit , commit-msg , post-commit , prepare-commit-msg )
• Mettre en scène, annuler la mise en scène, restaurer et réinitialiser des fichiers, des morceaux et des lignes
• Cachetage (enregistrer, afficher, appliquer, supprimer et inspecter)
• Pousser/Récupérer vers/depuis la télécommande
• Liste des succursales (créer, renommer, supprimer, extraire, télécommandes)
• Parcourir/ Rechercher le journal de validation, différences dans les modifications validées
• Interface utilisateur du terminal réactive
• API git asynchrone pour le contrôle des fluides
• Prise en charge des sous-modules
• Signature du commit gpg avec des lacunes (voir #97))

2. Motivation ^{Haut ▲}

Je fais la plupart de mon travail avec Git dans un terminal, mais je me retrouve fréquemment à utiliser des interfaces graphiques Git pour certains cas d'utilisation tels que : index, commit, diff, stash, blâme et journal.

Malheureusement, les interfaces graphiques Git populaires échouent toutes sur des référentiels géants ou deviennent insensibles et inutilisables.

GitUI vous offre l'expérience utilisateur et le confort d'une interface graphique Git mais directement dans votre terminal tout en étant portable, rapide, gratuit et open source.

3. Benchmarks ^{Haut ▲}

Pour une présentation Meetup RustBerlin (diapositives), j'ai comparé lazygit , tig et gitui en analysant l'intégralité du référentiel Linux git (qui contient plus de 900 000 commits) :

	Temps	Mémoire (Go)	Binaire (Mo)	Gèle	Crashes
gitui	24 s ✅	0,17 ✅	10	Non ✅	Non ✅
lazygit	57 s	2.6	25	Oui	Parfois
tig	4 min 20 s	1.3	0,6 ✅	Parfois	Non ✅

4. Route(carte) vers 1.0 ^{Haut ▲}

Voici les objectifs de haut niveau avant d'annoncer 1.0 :

• visualiser la structure de branchement dans l'onglet journal (#81)
• rebase interactif (#32)

5. Limitations connues ^{Haut ▲}

• pas de support de dépôt clairsemé (voir #1226)
• pas de support git-lfs (voir #1089)
• credential.helper pour https doit être explicitement configuré (voir #800)

Actuellement, cet outil ne remplace pas entièrement le shell git , mais les deux outils fonctionnent bien en tandem.

Les priorités de gitui portent sur les fonctionnalités qui me rendent fou lorsqu'elles sont effectuées sur le shell git , comme le stockage, les lignes de préparation ou les morceaux. À terme, je pourrai travailler à faire gitui une solution unique - mais pour cela j'ai besoin d'aide - ce n'est qu'un projet de temps libre pour le moment.

Tout soutien est le bienvenu ! Les sponsors aussi ! ❤️

6. Installation ^{Haut ▲}

GitUI est en version bêta et peut contenir des bugs et des fonctionnalités manquantes. Cependant, pour un usage personnel, il est raisonnablement stable et est utilisé tout en se développant.

Divers gestionnaires de packages

Instructions d'installation

Arch Linux

pacman -S gitui

Feutre

sudo dnf install gitui

Gentoo

Disponible en superposition dm9pZCAq

sudo eselect repository enable dm9pZCAq
sudo emerge --sync dm9pZCAq
sudo emerge dev-vcs/gitui::dm9pZCAq

ouvertSUSE

sudo zypper install gitui

Homebrew (macOS)

brew install gitui

MacPorts (macOS)

port install gitui

Winget (Windows)

 winget install gitui

Scoop (Windows)

 scoop install gitui

Chocolaté (Windows)

 choco install gitui

Nix (Nix/NixOS)

Nixpkg

 nix-env -iA nixpkgs.gitui

NixOS

 nix-env -iA nixos.gitui

Termux (Android)

 pkg install gitui

Anaconda

 conda install -c conda-forge gitui

Libérer les binaires

Disponible en téléchargement dans les versions

Binaires disponibles pour :

Linux

• gitui-linux-x86_64.tar.gz (linux musl lié statiquement)
• gitui-linux-aarch64.tar.gz (Linux sur arm 64 bits)
• gitui-linux-arm.tar.gz
• gitui-linux-armv7.tar.gz

Tous contiennent un seul fichier binaire

macOS

• gitui-mac.tar.gz (arm64)
• gitui-mac-x86.tar.gz (intel x86)

Fenêtres

• gitui-win.tar.gz (binaire unique 64 bits)
• gitui-win.msi (paquet d'installation 64 bits)

Constructions nocturnes

voir NIGHTLIES.md

7. Construire ^{le haut ▲}

Exigences

• Version rust / cargo minimale prise en charge : 1.70

  • Voir Installer Rust

• Pour créer une dépendance openssl (voir https://docs.rs/openssl/latest/openssl/)

  • perl >= 5.12 (Strawberry Perl fonctionne pour Windows https://strawberryperl.com/)
  • compilateur ac (msvc, gcc ou clang, cargo le trouvera)

• Pour exécuter la suite de tests complète, Python est requis (et il doit être invocable en tant que python )

Installation de fret

Le moyen le plus simple de commencer à jouer avec gitui est de créer cargo et de l'installer avec cargo install gitui --locked . Si vous n'êtes pas familier avec la rouille et le fret : Premiers pas avec Rust

Caractéristiques du fret

trace-libgit

activer le traçage libgit2

fonctionne si libgit2 est construit avec -DENABLE_TRACE=ON

cette fonctionnalité activée par défaut, à désactiver : cargo install --no-default-features

8. FAQ ^{Haut ▲}

voir la page FAQ

9. Diagnostic ^{Haut ▲}

Pour exécuter avec la journalisation activée, exécutez gitui -l .

Cela se connectera à :

• macOS : $HOME/Library/Caches/gitui/gitui.log
• Linux utilisant XDG : $XDG_CACHE_HOME/gitui/gitui.log
• Linux : $HOME/.cache/gitui/gitui.log
• Windows : %LOCALAPPDATA%/gitui/gitui.log

10. Thème de couleur ^{Haut ▲}

gitui devrait automatiquement fonctionner sur les thèmes de terminaux clairs et sombres.

Cependant, vous pouvez tout personnaliser à votre guise : Voir Thèmes.

11. Raccourcis clavier ^{Haut ▲}

Les raccourcis clavier peuvent être personnalisés : voir Key Config pour savoir comment les définir sur des liaisons de type vim .

12. Sponsoring ^{Haut ▲}

13. Inspiration ^{Haut ▲}

• paresseux
• tig
• GitUp
  • Ce serait bien de trouver un moyen d'avoir la vue cartographique disponible dans un outil terminal
• git-brunch

14. Contribuer ^{Haut ▲}

Voir CONTRIBUTION.md.

15. ^{Haut des contributeurs ▲}

Merci à tous les contributeurs qui contribuent à rendre GitUI incroyable ! ❤️

Voulez-vous devenir co-responsable ? Nous vous cherchons !