蝙蝠

贊助商

特別感謝我們最大的贊助商：

您的應用程序，企業就緒。
_{只需幾行程式碼即可開始向企業客戶銷售。}
^{只需幾分鐘而不是幾個月即可新增單一登入（甚至更多）。}

Warp，智慧終端
_{像高級用戶一樣使用 A​​I 和您的開發團隊運行命令}
^{知識盡在一個快速、直覺的終端機。適用於 MacOS 或 Linux。}

語法高亮

bat支援大量程式設計和標記語言的語法突出顯示：

Git 集成

bat與git通訊以顯示索引的修改（請參閱左側欄）：

顯示不可列印的字符

您可以使用-A / --show-all選項來顯示和反白顯示不可列印的字元：

自動尋呼

預設情況下，如果輸出對於一個螢幕來說太大，則bat會將其自己的輸出傳送到尋呼機（例如less ）。如果您希望bat始終像cat一樣工作（從不分頁輸出），您可以在命令列或設定檔中設定--paging=never作為選項。如果您打算在 shell 配置中將cat別名為bat ，則可以使用alias cat='bat --paging=never'來保留預設行為。

檔案串聯

即使設定了尋呼機，您仍然可以使用bat來連接檔案。每當bat偵測到非互動終端時（即，當您透過管道進入另一個流程或檔案）， bat將充當cat的直接替代品並回退到列印純檔案內容，無論--pager選項如何價值。

如何使用

在終端機上顯示單一文件

>bat README.md

一次顯示多個文件

> 蝙蝠 src/*.rs

從 stdin 讀取，自動確定語法（注意，僅當可以從檔案的第一行確定語法時，突出顯示才會起作用，通常透過諸如#!/bin/sh之類的 shebang ）

 > 捲曲 -s https://sh.rustup.rs |蝙蝠

從 stdin 讀取，明確指定語言

> yaml2json .travis.yml | json_pp |蝙蝠 -l json

顯示並反白顯示不可列印的字元：

 > bat -A /etc/hosts

用它作為cat替代品：

 bat > note.md # 快速新建檔案 bat header.md content.md footer.md > document.md

bat -n main.rs # （僅）顯示行號 bat f - g # 輸出 'f'，然後是 stdin，然後是 'g'。

與其他工具集成

fzf

您可以使用bat作為fzf的預覽器。為此，請使用bat s --color=always選項強制彩色輸出。您也可以使用--line-range選項來限制長檔案的載入時間：

 fzf --preview“bat --color=always --style=numbers --line-range=:500 {}”

有關更多信息，請參閱fzf的README 。

find或fd

您可以使用find的-exec選項透過bat預覽所有搜尋結果：

找到...-exec bat {} +

如果您碰巧使用fd ，則可以使用-X / --exec-batch選項執行相同操作：

 fd … -X 蝙蝠

ripgrep

透過batgrep ， bat可以用作ripgrep搜尋結果的印表機。

 batgrep 針 src/

tail -f

bat可以與tail -f結合使用，透過語法突出顯示持續監視給定檔案。

尾-f /var/log/pacman.log | bat --paging=從不 -l 日誌

請注意，我們必須關閉分頁才能使其正常運作。我們也明確指定了語法（ -l log ），因為在這種情況下無法自動偵測到它。

git

您可以將bat與git show結合使用，以使用正確的語法反白顯示給定檔案的舊版本：

 git show v0.6.0:src/main.rs | git show v0.6.0:src/main.rs |蝙蝠-l rs

git diff

您可以將bat與git diff結合起來，透過適當的語法突出顯示來查看程式碼變更周圍的行：

蝙蝠差（）{
    git diff --name-only --relative --diff-filter=d | git diff --name-only --relative --diff-filter=d | xargs 蝙蝠 --diff
}

如果您喜歡將其用作單獨的工具，請查看bat-extras中的batdiff 。

如果您正在尋找對 git 和 diff 操作的更多支持，請查看delta 。

xclip

bat輸出中的行號和 Git 修改標記可能會使複製檔案內容變得困難。為了防止這種情況，您可以使用-p / --plain選項呼叫bat或簡單地將輸出傳輸到xclip ：

蝙蝠主.cpp |剪輯

bat將偵測輸出是否被重定向並列印純檔案內容。

man

透過設定MANPAGER環境變量， bat可以用作man的著色分頁器：

導出 MANPAGER =“sh -c 'col -bx | bat -l man -p'”man 2 選擇

（如果您使用的是 Debian 或 Ubuntu，請將bat替換為batcat ）

如果遇到格式問題，可能還需要設定MANROFFOPT="-c" 。

如果您希望將其捆綁在新命令中，您也可以使用batman 。

請注意，手冊頁語法是在此儲存庫中開發的，仍然需要一些工作。

另請注意，這不適用於 Mandocs man實現。

prettier / shfmt / rustfmt

prettybat腳本是一個包裝器，它將格式化程式碼並使用bat列印它。

反白顯示--help訊息

您可以使用bat為幫助文字著色： $ cp --help | bat -plhelp

您也可以使用包裝器來解決此問題：

 # 在你的 .bashrc/.zshrc/*rcalias 中 bathelp='bat --plain --language=help'help() {"$@" --help 2>&1 |蝙蝠幫助
}

然後你可以執行$ help cp或$ help git commit 。

當您使用zsh時，您也可以使用全域別名來完全覆寫-h和--help ：

別名 -g -- -h='-h 2>&1 | bat --language=help --style=plain'alias -g -- --help='--help 2>&1 |蝙蝠--語言=幫助--風格=普通'

這樣，您可以繼續使用cp --help ，但獲得彩色幫助頁面。

請注意，在某些情況下， -h可能不是--help的簡寫（例如使用ls ）。

請報告此存儲庫中幫助語法的任何問題。

安裝

在 Ubuntu 上（使用apt ）

...以及其他基於 Debian 的 Linux 發行版。

bat自 20.04（“Focal”）起在 Ubuntu 上可用，自 2021 年 8 月起在 Debian 上可用（Debian 11 - “Bullseye”）。

如果您的 Ubuntu/Debian 安裝足夠新，您只需運行：

 sudo apt安裝bat

重要：如果您以這種方式安裝bat ，請注意，可執行檔可能會安裝為batcat而不是bat （由於與另一個套件的名稱衝突）。您可以設定bat -> batcat符號連結或別名，以防止因此可能出現的任何問題，並與其他發行版保持一致：

 mkdir -p ~/.local/bin
ln -s /usr/bin/batcat ~/.local/bin/bat

在 Ubuntu 上（使用最新的.deb軟體包）

...以及其他基於 Debian 的 Linux 發行版。

如果該軟體包尚未升級到您的 Ubuntu/Debian 安裝，或者您想要最新版本的bat ，請從發布頁面下載最新的.deb軟體包並透過以下方式安裝：

 sudo dpkg -i bat_0.18.3_amd64.deb # 調整版本號碼和架構

在 Alpine Linux 上

您可以從官方來源安裝bat軟體包，前提是您啟用了適當的儲存庫：

 apk新增bat

在 Arch Linux 上

您可以從官方來源安裝bat套件：

吃豆人-S 蝙蝠

在軟呢帽上

您可以從官方 Fedora Modular 儲存庫安裝bat軟體包。

 dnf安裝bat

在 Funtoo Linux 上

您可以從 dev-kit 安裝bat套件。

出現系統應用程式/bat

在 Gentoo Linux 上

您可以從官方來源安裝bat套件：

出現系統應用程式/bat

在 Void Linux 上

您可以透過 xbps-install 安裝bat ：

 xbps-安裝-S bat

在 Termux 上

您可以透過 pkg 安裝bat ：

 pkg安裝bat

在 FreeBSD 上

您可以使用 pkg 安裝預編譯的bat套件：

 pkg安裝bat

或從 FreeBSD ports 自己建置它：

 cd /usr/ports/textproc/bat
進行安裝

在 OpenBSD 上

您可以使用pkg_add(1)安裝bat套件：

 pkg_add 蝙蝠

通過尼克斯

您可以使用 nix 套件管理器安裝bat ：

 nix-env -i 蝙蝠

透過弗洛克斯

您可以使用 Flox 安裝bat

 flox安裝bat

在 openSUSE 上

您可以使用 zypper 安裝bat ：

 zypper 安裝蝙蝠

透過快照包

目前沒有建議的 snap 包可用。現有的軟體包可能可用，但不受官方支持，並且可能存在問題。

在 macOS（或 Linux）上透過 Homebrew

您可以使用 Homebrew 安裝bat ：

釀造安裝蝙蝠

在 macOS 上透過 MacPorts

或使用MacPorts安裝bat ：

連接埠安裝bat

在 Windows 上

在 Windows 上安裝bat有幾個選項。安裝bat後，請查看「在 Windows 上使用bat 」部分。

先決條件

您需要安裝 Visual C++ Redistributable 軟體套件。

與WinGet

您可以透過 WinGet 安裝bat ：

 winget安裝sharkdp.bat

含巧克力味

您可以透過 Chocolatey 安裝bat ：

 choco安裝bat

帶湯匙

您可以透過 scoop 安裝bat ：

舀安裝蝙蝠

從預先建置的二進位檔案：

您可以從發布頁面下載預先建置的二進位文件，

您需要安裝 Visual C++ Redistributable 軟體套件。

來自二進位檔案

請查看發布頁面，了解適用於許多不同體系結構的bat預建置版本。靜態連結的二進位檔案也可用：尋找檔案名稱中帶有musl的檔案。

從源頭

如果您想從原始程式碼建立bat ，則需要 Rust 1.70.0 或更高版本。然後你可以使用cargo來建立一切：

貨物安裝--鎖定蝙蝠

請注意，無法以這種方式安裝其他文件，例如手冊頁或 shell 完成文件。它們將由cargo生成，並且應該在Cargo目標資料夾中可用（在build下）。

客製化

突顯主題

使用bat --list-themes取得所有可用主題的清單以進行語法突出顯示。若要選擇TwoDark主題，請使用--theme=TwoDark選項呼叫bat或將BAT_THEME環境變數設為TwoDark 。在 shell 的啟動檔案中使用export BAT_THEME="TwoDark"以使變更永久生效。或者，使用bat的設定檔。

如果您想預覽自訂文件上的不同主題，可以使用以下命令（為此需要fzf ）：

蝙蝠--列表主題| fzf --preview="bat --theme={} --color=always /path/to/file"

bat根據終端的背景顏色自動選擇適當的主題。您可以使用--theme-light / --theme-light選項或BAT_THEME_DARK / BAT_THEME_LIGHT環境變數來自訂所使用的主題。如果您經常在深色和淺色模式之間切換，這尤其有用。

您也可以按照下面的「新增主題」部分來使用自訂主題。

8 位元主題

bat有三個始終使用 8 位元顏色的主題，即使真彩色支援可用：

• ansi在任何終端上看起來都不錯。它使用 3 位元顏色：黑色、紅色、綠色、黃色、藍色、洋紅色、青色和白色。

• base16專為 Base16 終端主題設計。它根據 base16 樣式指南使用 4 位元顏色（3 位元顏色加上明亮的變體）。

• base16-256是為 base16-shell 設計的。它用 16 到 21 的 8 位元顏色取代某些明亮的顏色。

儘管這些主題受到更多限制，但它們比真彩色主題有三個優勢。他們：

• 享受最大的兼容性。某些終端實用程式不支援超過 3 位元顏色。

• 適應終端主題變化。即使對於已經列印的輸出也是如此。

• 在視覺上與其他終端軟體更好地協調。

輸出方式

您可以使用--style選項來控制bat輸出的外觀。例如，您可以使用--style=numbers,changes來只顯示 Git 變更和行號，但不顯示網格和檔案頭。設定BAT_STYLE環境變數以使這些變更永久生效或使用bat的設定檔。

提示

如果您在bat的設定檔中指定預設樣式，則可以使用--style命令列參數來變更單次執行bat期間顯示的元件。透過在組件前面加上+或-前綴，可以將其新增至目前樣式或從目前樣式中刪除。

例如，如果您的設定包含--style=full,-snip ，則可以使用--style=-grid,+snip執行 bat 來刪除網格並重新新增snip元件。或者，如果您想完全覆蓋樣式，可以使用--style=numbers來只顯示行號。

新增語法/語言定義

如果您發現bat中不提供特定語法，您可以按照這些說明輕鬆地將新語法新增至目前的bat安裝。

bat使用優秀的syntect函式庫進行語法高亮。 syntect可以讀取任何 Sublime Text .sublime-syntax檔案和主題。

Package Control 是尋找 Sublime Syntax 套件的一個很好的資源。一旦找到語法：

1. 建立一個包含語法定義檔的資料夾：

    mkdir -p "$(bat --config-dir)/syntaxes"cd "$(bat --config-dir)/syntaxes"# 將新的'.sublime-syntax' 語言定義檔# 放入此資料夾（或其子目錄） ），例如：git clone https://github.com/tellnobody1/sublime-purescript-syntax

2. 現在使用以下命令將這些檔案解析到二進位快取中：

   蝙蝠緩存--構建

3. 最後，使用bat --list-languages檢查新語言是否可用。

   如果您想返回預設設置，請致電：

   蝙蝠快取--清除

4. 如果您認為預設應在bat中包含特定語法，請在閱讀此處的政策和說明後考慮開啟「語法請求」票證：開啟語法請求。

新增主題

這與我們添加新語法定義的方式非常相似。

首先，使用新語法突出顯示主題建立一個資料夾：

 mkdir -p "$(bat --config-dir)/themes"cd "$(bat --config-dir)/themes"# 下載 '.tmTheme' 格式的主題，例如：git clone https:// github. com/greggb/sublime-snazzy# 更新二進位快取bat 快取--build

最後，使用bat --list-themes檢查新主題是否可用。

新增或變更文件類型關聯

您可以使用--map-syntax命令列選項新增的（或變更現有的）檔案名稱模式。此選項採用pattern:syntax形式的參數，其中pattern是與檔案名稱和絕對檔案路徑相符的全域模式。 syntax部分是受支援語言的全名（使用bat --list-languages進行概述）。

注意：您可能希望將此選項用作bat配置檔案中的條目以實現持久性，而不是一次性將其傳遞到命令列。通常，如果您想手動指定文件的語言，只需使用-l即可。

範例：若要對所有具有.conf檔案副檔名的檔案使用「INI」語法反白顯示，請使用

--map-syntax='*.conf:INI'

範例：若要使用「Git Ignore」語法開啟所有名為.ignore （完全符合）的文件，請使用：

 --map-syntax='.ignore:Git 忽略'

範例：若要使用「Apache Conf」語法開啟/etc/apache2子資料夾中的所有.conf文件，請使用（此映射已內建）：

 --map-syntax='/etc/apache2/**/*.conf:Apache Conf'

使用不同的尋呼機

bat使用PAGER環境變數中指定的分頁程式。如果未設定此變量，則預設使用less 。如果要使用不同的尋呼機，可以修改PAGER變數或設定BAT_PAGER環境變數以覆寫PAGER中指定的內容。

筆記

如果PAGER是more或most ， bat會默默地使用less來代替以確保對顏色的支撐。

如果要將命令列參數傳遞給尋呼機，也可以透過PAGER / BAT_PAGER變數來設定它們：

導出 BAT_PAGER="少-RF"

除了使用環境變數之外，您還可以使用bat的設定檔來設定尋呼機（ --pager選項）。

使用less作為尋呼機

當使用less作為尋呼機時， bat會自動將額外的選項傳遞給less以改善體驗。具體來說， -R / --RAW-CONTROL-CHARS 、 -F / --quit-if-one-screen ，並且在某些條件下， -X / --no-init和/或-S / --chop-long-lines 。

重要的

如果出現以下情況，則不會新增這些選項：

• 尋呼機沒有命名為less 。

• --pager參數包含任何命令列參數（例如--pager="less -R" ）。

• BAT_PAGER環境變數包含任何命令列參數（例如export BAT_PAGER="less -R" ）

在以下情況下，不會新增--quit-if-one-screen選項：

• 使用--paging=always參數。

• BAT_PAGING環境設定為always 。

需要-R選項才能正確解釋 ANSI 顏色。

如果輸出大小小於終端的垂直大小， -F選項指示less立即退出。這對於小檔案來說很方便，因為您不必按q退出尋呼機。

需要-X選項來修復less版本less的版本中的--quit-if-one-screen功能的錯誤。如果您想在舊版的less上啟用滑鼠滾輪滾動且不介意失去「if-one-screen」功能，則可以將尋呼機（透過--pager或BAT_PAGER ）設為less -R 。對於 530 less或更高版本，它應該可以開箱即用。

當使用bat的-S / --chop-long-lines選項時，會新增-S選項。這告訴less截斷任何大於終端寬度的行。

縮排

bat自行將製表符擴展為 4 個空格，而不依賴於尋呼機。若要變更此設置，只需新增--tabs參數以及要顯示的空格數。

注意：不會考慮為尋呼機定義製表位（透過bat的--pager參數，或透過less的LESS環境變數），因為尋呼機已經獲得擴展的空格而不是製表符。新增此行為是為了避免側邊欄引起的縮排問題。使用--tabs=0呼叫bat將覆蓋它並讓分頁器使用選項卡。

深色模式

如果您在 macOS 中使用深色模式功能，您可能需要將bat配置為根據作業系統主題使用不同的主題。以下程式碼片段在深色模式下使用default主題，在淺色模式下使用GitHub主題。

別名 cat="bat --theme=$(預設讀取 -globalDomain AppleInterfaceStyle &> /dev/null && echo 預設 || echo GitHub)"

設定檔

也可以使用設定檔自訂bat 。該檔案的位置取決於您的作業系統。若要取得系統的預設路徑，請呼叫

bat --設定檔

或者，您可以使用BAT_CONFIG_PATH或BAT_CONFIG_DIR環境變數分別將bat指向設定檔或設定目錄的非預設位置：

導出 BAT_CONFIG_PATH="/path/to/bat/bat.conf"導出 BAT_CONFIG_DIR="/path/to/bat"

可以使用--generate-config-file選項建立預設設定檔。

 bat --產生設定檔

現在還有一個系統範圍的設定文件，在 Linux 和 Mac OS 上位於/etc/bat/config下，在 Windows 上位於C:ProgramDatabatconfig下。如果存在系統範圍的設定文件，則使用者配置的內容將簡單地附加到其中。

格式

設定檔是命令列參數的簡單列表。使用bat --help查看可能的選項和值的完整清單。此外，您可以透過在行前面新增#字元來新增註解。

設定檔範例：

 # 將主題設為「TwoDark」--theme="TwoDark"# 顯示行號、Git 修改和檔案頭（但沒有網格）--style="numbers,changes,header"# 在終端機上使用斜體文字（不是所有終端支援）--italic-text=always# 對 Arduino .ino 檔案使用 C++ 語法--map-syntax "*.ino:C++"

在Windows上使用bat

bat大多數情況下可以在 Windows 上開箱即用，但有些功能可能需要額外設定。

先決條件

您需要安裝 Visual C++ Redistributable 軟體套件。

呼叫

Windows 僅包含非常有限的more形式的尋呼機。您可以從其主頁或透過 Chocolatey 以less下載 Windows 二進位。要使用它，請將二進位檔案放置在PATH中的目錄中或定義一個環境變數。 Chocolatey 軟體包的自動安裝程度less 。

顏色

自 v1511 起，Windows 10 原生支援conhost.exe （命令提示字元）和 PowerShell 以及較新版本的 bash 中的顏色。在早期版本的 Windows 上，您可以使用 Cmder，其中包含 ConEmu。

注意：舊版的less無法正確解釋 Windows 上的顏色。若要解決此問題，您可以在安裝 Git 時將可選的 Unix 工具新增至您的 PATH 中。如果您沒有安裝任何其他尋呼機，則可以透過傳遞--paging=never或將BAT_PAGER設為空字串來完全停用分頁。

西格文

Windows 上的bat本身不支援 Cygwin 的 unix 樣式路徑 ( /cygdrive/* )。當傳遞絕對 cygwin 路徑作為參數時， bat將遇到以下錯誤： The system cannot find the path specified. (os error 3)

這可以透過建立包裝器或將以下函數新增至.bash_profile檔案中來解決：

 bat() {本地索引local args=("$@")for $(seq 0 ${#args[@]}) 中的索引; docase "${args[index]}" in-*) continue;;*) [ -e "${args[index]}" ] && args[index]="$(cygpath --windows "${args[索引]}")";;esacdonecommand bat "${args[@]}"}

故障排除

輸出亂碼

如果輸入檔包含顏色代碼或其他 ANSI 轉義序列或控製字符， bat在執行語法突出顯示和文本換行時將出現問題，因此輸出可能會出現亂碼。

如果您的bat版本支援--strip-ansi=auto選項，則可以使用它在語法反白顯示之前刪除此類序列。或者，您可以透過將--color=never --wrap=never選項傳遞給bat來停用語法反白和換行。

筆記

--strip-ansi的auto選項可以避免在語法為純文字時刪除轉義序列。

端子和顏色

bat處理帶或不帶真彩色支援的終端。但是，大多數語法突出顯示主題中的顏色並未針對 8 位元顏色進行最佳化。因此，強烈建議您使用支援 24 位元真彩色的終端（ terminator 、 konsole 、 iTerm2等），或使用專為有限色彩集設計的基本 8 位元主題之一。請參閱本文以了解更多詳細資訊以及支援真彩色的終端的完整清單。

確保您的 truecolor 終端將COLORTERM變數設為truecolor或24bit 。否則， bat將無法確定是否支援 24 位元轉義序列（並回退到 8 位元顏色）。

行號和網格幾乎不可見

請嘗試不同的主題（有關列表，請參閱bat --list-themes ）。 OneHalfDark和OneHalfLight主題提供更明亮的網格和線條顏色。

文件編碼

bat本身支援 UTF-8 和 UTF-16。對於所有其他檔案編碼，您可能需要先轉換為 UTF-8，因為通常無法自動偵測編碼。您可以使用iconv來執行此操作。範例：如果您有一個採用 Latin-1 (ISO-8859-1) 編碼的 PHP 文件，您可以呼叫：

 iconv -f ISO-8859-1 -t UTF-8 my-file.php | iconv -f ISO-8859-1 -t UTF-8 my-file.php |蝙蝠

注意：如果bat無法自動偵測語法，您可能必須使用-l / --language選項。

發展

# 遞歸克隆檢索所有子模組git clone --recursive https://github.com/sharkdp/bat# Build (debug version)cd bat
cargo build --bins# 運行單元測試和整合測試cargo test# 安裝（發布版本）cargo install --path 。 --locked# 使用修改後的語法和主題來建立 bat 二進位檔案bash asset/create.sh
貨物安裝--路徑。 --鎖定--強制

如果您想建立一個使用bat的漂亮列印功能作為庫的應用程序，請查看 API 文件。請注意，當您依賴bat作為庫時，您必須使用regex-onig或regex-fancy作為功能。

貢獻

查看CONTRIBUTING.md指南。

維護者

• 鯊魚dp

• eth-p

• 基斯·霍爾

• 恩塞利克

安全漏洞

如果您想報告bat中的漏洞，請透過電子郵件聯絡 David Peter。

專案目標和替代方案

bat試圖實現以下目標：

• 提供美觀、進階的語法高亮顯示

• 與 Git 整合以顯示文件修改

• 成為 (POSIX) cat的直接替代品

• 提供用戶友好的命令列介面

如果您正在尋找類似的程序，有很多選擇。請參閱此文件進行比較。

執照

版權所有 (c) 2018-2023 bat-developers。

bat可以根據 MIT 授權或 Apache 授權 2.0 的條款提供，具體由您選擇。

有關許可證詳細信息，請參閱 LICENSE-APACHE 和 LICENSE-MIT 文件。