Synopsis

git instaweb [--httpd=<daemon>] [--port=<n>] [--start | --stop | --restart]

Description

The git instaweb command spins up a local web server (lighttpd, Apache, webrick, or Python's http.server) hosting the gitweb interface for the current repository. It opens a browser pointing at it, giving you a quick web UI for browsing history, files, and diffs without any setup.

Despite being a command in core Git, gitweb itself is older Perl-based software and isn't always installed by default on modern distros. Many users now prefer running a local instance of cgit, gitea, or simply browsing on a hosted forge.

Dans l'usage quotidien, git instaweb s'intègre étroitement avec les alias de shell, les plugins d'éditeur et l'intégration continue. Les utilisateurs avancés ajoutent souvent des alias combinant les flags qu'ils passent toujours, ou enveloppent la commande dans des scripts qui appliquent les conventions d'équipe. Le formatage de la sortie peut être personnalisé via la configuration Git — pretty formats, schémas de couleurs et comportement du pager sont tous ajustables. Quand quelque chose tourne mal, la première étape de diagnostic est généralement de relancer la commande avec GIT_TRACE=1 dans l'environnement, ce qui révèle les appels de plomberie sous-jacents. Pour les situations inhabituelles, la sortie --help (git instaweb --help) ouvre la page de manuel complète avec les détails de chaque option, y compris celles rarement utilisées dans les workflows ordinaires mais essentielles pour le débogage ou le scripting à grande échelle.

Comprendre comment git instaweb interagit avec le reste du modèle de données de Git — la base d'objets, l'index, les refs et l'arborescence de travail — est rentable. Chaque commande opère sur un sous-ensemble de ces pièces, et savoir laquelle elle touche aide à prédire les résultats et récupérer après les erreurs. Lire la documentation officielle de Git en parallèle de la pratique sur un dépôt jetable est la façon la plus rapide d'intérioriser les subtilités. La plupart des problèmes de production avec Git proviennent de l'une de trois causes : comportement par défaut surprenant, opérations réseau partielles, ou réécriture d'historique déjà partagé. Un modèle mental fonctionnel des effets de bord de git instaweb aide à éviter les trois.

Options courantes

Exemples

git instaweb --httpd=webrick
# Start gitweb backed by Ruby's WEBrick

git instaweb --port=8080 --start
# On a custom port

git instaweb --stop
# Tear down

git config --global instaweb.httpd webrick
# Save default for future invocations

Erreurs fréquentes

Missing dependencies (Perl modules for gitweb, the chosen httpd) cause cryptic errors. Some distros ship gitweb in a separate package. For modern needs, consider cgit or hosted services.

Commandes liées

gitweb, git daemon, git http-backend, git config