bat Cheatsheet
catUn remplacement moderne de cat avec coloration syntaxique, intégration Git et pagination automatique.
Installation
| Plateforme | Commande |
|---|
| Ubuntu/Debian | sudo apt install bat (binary may be named batcat) |
| Arch Linux | sudo pacman -S bat |
| Fedora/RHEL | sudo dnf install bat |
| macOS (Homebrew) | brew install bat |
| macOS (MacPorts) | sudo port install bat |
| Windows (Scoop) | scoop install bat |
| Windows (Chocolatey) | choco install bat |
| Windows (Winget) | winget install sharkdp.bat |
| Rust/Cargo | cargo install --locked bat |
| Docker | docker pull danlynn/bat |
Remarque : Sur Debian/Ubuntu, créez un alias si nécessaire : alias bat='batcat' | |
Commandes de base
| Commande | Description |
|---|
bat file.txt | Afficher le fichier avec coloration syntaxique et numéros de ligne |
bat file1.txt file2.py | Afficher plusieurs fichiers avec des en-têtes |
bat -n file.txt | Afficher explicitement les numéros de ligne (activé par défaut) |
bat -p file.txt | Plain mode (no decorations, like cat) |
bat -pp file.txt | Mode plain supplémentaire (sortie complètement plain) |
bat -A file.txt | Afficher tous les caractères non imprimables (tabulations, espaces, fins de ligne) |
bat -r 10:20 file.txt | Afficher la plage de lignes spécifique (lignes 10-20) |
bat -r :50 file.txt | Afficher les 50 premières lignes |
bat -r 100: file.txt | Afficher de la ligne 100 à la fin |
| `echo “text” \ | bat` |
bat --list-languages | Afficher tous les langages de programmation pris en charge |
bat --list-themes | Afficher tous les thèmes de couleur disponibles |
bat -l python file.txt | Forcer la mise en surbrillance de langage/syntaxe spécifique |
bat --plain file.txt | Désactiver la coloration syntaxique |
bat --paging=never file.txt | Désactiver la pagination automatique |
Utilisation avancée
| Commande | Description |
|---|
bat --theme="Dracula" file.py | Utiliser un thème de couleur spécifique |
bat --diff file.txt | Afficher les modifications Git avec la coloration syntaxique |
bat --no-git file.txt | Désactiver les marqueurs d’intégration Git |
bat --tabs=4 file.py | Définir la largeur personnalisée des onglets |
bat --wrap=never file.txt | Désactiver le retour à la ligne |
bat --terminal-width=80 file.txt | Forcer une largeur de terminal spécifique |
bat --style=numbers,changes file.txt | Afficher uniquement les numéros de ligne et les modifications Git |
bat --style=header,grid file.txt | Afficher uniquement les séparateurs d’en-tête et de grille |
bat --style=plain file.txt | Supprimer toutes les décorations |
bat --file-name="Custom" file.txt | Afficher le nom personnalisé dans l’en-tête |
bat --decorations=never file.txt | Désactiver toutes les décorations (même lorsqu’elles sont appropriées) |
bat --color=always file.txt | Forcer la sortie en couleur (même lors du transfert de données) |
bat --paging=always file.txt | Forcer le pager même pour les petits fichiers |
bat --pager="less -RF" file.txt | Utiliser un pager personnalisé avec des options |
bat --map-syntax='*.conf:INI' file.conf | Mapper l’extension de fichier à une syntaxe spécifique |
bat --generate-config-file | Générer le fichier de configuration par défaut |
bat cache --build | Reconstruire le cache de syntaxe/thème |
bat cache --clear | Effacer le cache de syntaxe/thème |
Configuration
Emplacements des fichiers de configuration
| Plateforme | Chemin |
|---|
| Linux/macOS | ~/.config/bat/config |
| Windows | %APPDATA%\bat\config |
Exemple de fichier de configuration
Créez ~/.config/bat/configavec vos préférences :
# Set default theme
--theme="Dracula"
# Always show line numbers and changes
--style="numbers,changes,header,grid"
# Use 4-space tabs
--tabs=4
# Automatic paging
--paging=auto
# Show non-printable characters
--show-all
# Enable italic text (if terminal supports)
--italic-text=always
# Custom syntax mappings
--map-syntax="*.conf:INI"
--map-syntax=".ignore:Git Ignore"
--map-syntax="*.jenkinsfile:Groovy"
--map-syntax="*.log:Log"
--map-syntax=".env:Bash"
Variables d’environnement
# Set default theme
export BAT_THEME="Dracula"
# Set default style components
export BAT_STYLE="numbers,changes,header"
# Set default pager
export BAT_PAGER="less -RF"
# Disable paging entirely
export BAT_PAGER=""
# Custom config directory
export BAT_CONFIG_PATH="/custom/path/to/config"
Thèmes personnalisés
# Create themes directory
mkdir -p "$(bat --config-dir)/themes"
# Download theme file (.tmTheme format)
cd "$(bat --config-dir)/themes"
wget https://example.com/theme.tmTheme
# Rebuild cache to use new theme
bat cache --build
Composants de style
Composants de style disponibles (séparés par des virgules) :
| Composant | Description |
|---|
full | Tous les composants (default) |
auto | Automatique en fonction de la sortie |
plain | Aucune décoration |
numbers | Numéros de ligne |
changes | Marqueurs de modification Git |
header | En-tête du nom de fichier |
grid | Séparateurs de grille |
rule | Règles horizontales |
snip | Marqueurs de sélection pour plages de lignes |
Cas d’utilisation courants
Cas d’utilisation : Revue de code avec intégration Git
# View file with Git changes highlighted
bat --diff src/main.py
# Compare with previous commit
git show HEAD~1:config.yaml | bat -l yaml --file-name="Previous Version"
# Review multiple changed files
git diff --name-only | xargs bat --diff
Cas d’utilisation : Analyse de fichiers journaux
# View application logs with syntax highlighting
bat --language=log /var/log/application.log
# View specific error section
bat -r 1000:2000 /var/log/syslog | grep ERROR
# Monitor live logs (disable paging)
tail -f /var/log/app.log | bat --paging=never -l log
# Search logs with context
bat /var/log/nginx/error.log | grep -C 5 "ERROR"
Cas d’utilisation : Gestion des fichiers de configuration
# Review system configurations
bat /etc/nginx/nginx.conf /etc/ssh/sshd_config
# Compare configurations side by side
diff <(bat -p config.prod.yml) <(bat -p config.dev.yml)
# Check for hidden characters in config
bat -A .env
# View Kubernetes resources
kubectl get deployment myapp -o yaml | bat -l yaml
Cas d’utilisation : Workflows Docker et conteneurs
# View Dockerfile with syntax highlighting
bat Dockerfile
# Inspect docker-compose configurations
bat docker-compose.yml docker-compose.override.yml
# View container logs with syntax
docker logs container_name 2>&1 | bat --paging=never -l log
# Display formatted JSON from API
curl -s https://api.github.com/repos/sharkdp/bat | bat -l json
Cas d’utilisation : Développement et débogage de scripts
# View shell script with line numbers
bat -n deploy.sh
# Check specific function (lines 45-78)
bat -r 45:78 automation.sh
# Detect problematic characters
bat -A problematic-script.sh
# View multiple related scripts
bat scripts/*.sh
Meilleures pratiques
- Utilisez
-ppour les scripts : Lors du pipe ou du scripting, utilisez bat -poubat --plainpour éviter les décorations qui pourraient interférer avec le traitement~/.config/bat/configavec votre thème et style préférés pour éviter les drapeaux répétitifsalias cat='bat --paging=never --style=plain'dans votre configuration de shell pour un remplacement transparent--difflors de la revue des modifications de code pour voir les modifications en ligne avec la coloration syntaxique--map-syntaxdans le fichier de configuration pour les types de fichiers spécifiques au projet (par exemple,.jenkinsfile``.conf)--paging=neverlors du transfert de la sortie vers d’autres commandes pour éviter les problèmes de pagineur interactif-lpour les fichiers sans extensions, spécifiez explicitement le langage avecbat cache --buildpour les rendre disponibles
Dépannage
| Problème | Solution |
|---|
Binary named batcat instead of bat | Create alias: alias bat='batcat' or symlink: ln -s /usr/bin/batcat ~/.local/bin/bat |
| No syntax highlighting | Check language support with bat --list-languages and use -l to force language |
| Pager interferes with pipes | Use bat --paging=never or set export BAT_PAGER="" |
| Theme not displaying correctly | Verify terminal supports 256 colors; try different theme with bat --theme="GitHub" |
| Custom theme not appearing | Ensure theme file is in $(bat --config-dir)/themes/ and run bat cache --build |
| Line numbers misaligned | Check tab width setting; adjust with --tabs=4 or in config file |
| Git integration not working | Ensure file is in Git repository; disable with --no-git if not needed |
| Config file changes ignored | Verify file location with bat --config-file; check for syntax errors in config |
| Performance issues with large files | Use --paging=never and pipe to less, or use line ranges with -r |
| Unicode characters display incorrectly | Ensure terminal uses UTF-8 encoding; check locale settings |
Référence rapide : Drapeaux courants
| Court | Long | Objectif |
|---|
-p | --plain | Mode de sortie standard |
-n | --number | Afficher les numéros de ligne |
-A | --show-all | Afficher les caractères non imprimables |
-l | --language | Définir la syntaxe du langage |
-r | --line-range | Afficher la plage de lignes |
-H | --highlight-line | Mettre en évidence des lignes spécifiques |
-d | --diff | Afficher le diff Git |
| --theme | Définir le thème de couleur |
| --style | Définir les composants de style |
| --paging | Contrôler le comportement du pager |
| --tabs | Définir la largeur de tabulation |
Note: Some placeholders (lines 6, 7, 11) were left empty as no specific text was provided in the original input. Would you like me to clarify or complete those lines?
