菜单

安装与使用

相关源文件

此页面介绍了如何在各种操作系统上安装 bat,并涵盖了基本用法。有关核心架构和内部组件的信息,请参阅 核心架构

安装方法

根据您的操作系统,可以通过多种方法安装 bat。安装过程会将 bat 命令添加到您的终端中,以便您能够以语法高亮和其他增强功能查看文件。

来源: README.md257-466

在 Linux 上

Ubuntu 和基于 Debian 的发行版

在 Ubuntu(20.04 "Focal" 及更高版本)和 Debian(Debian 11 "Bullseye" 及更高版本)上,您可以使用包管理器安装 bat

注意:由于与其他软件包名称冲突,可执行文件可能会安装为 batcat 而不是 bat。您可以创建符号链接或别名来解决此问题。

对于较新版本或较旧的发行版,您可以直接下载并安装 .deb 包。

来源: README.md261-288

其他 Linux 发行版

发行版安装命令
Alpine Linuxapk add bat
Arch Linuxpacman -S bat
Fedoradnf install bat
Gentooemerge sys-apps/bat
Void Linuxxbps-install -S bat
openSUSEzypper install bat

来源: README.md290-392

在 macOS 上

您可以使用 Homebrew 安装 bat

或者,使用 MacPorts

来源: README.md399-413

在 Windows 上

在 Windows 上安装 bat 有几种方法。

  1. 使用 WinGet

  2. 使用 Chocolatey

  3. 使用 Scoop

  4. release page 下载预构建的二进制文件。

注意:您需要作为先决条件安装 Visual C++ Redistributable 包。

来源: README.md415-450 README.md742-748

从二进制文件或源代码

对于任何平台,您都可以

  1. release page 下载预构建的二进制文件。
  2. 从源代码构建(需要 Rust 1.74.0 或更高版本)

来源: README.md452-468

基本用法

bat 被设计为 cat 命令的增强替代品,提供了语法高亮、Git 集成和其他有用功能。

来源:系统架构概览

查看文件

在终端中显示单个文件

一次显示多个文件

从标准输入读取并自动确定语法

从标准输入读取,并指定语言

显示不可打印字符

来源: README.md65-97

用作 cat 的替代品

来源: README.md99-109

自动分页

默认情况下,如果内容超出屏幕,bat 会将其输出通过管道传给分页器(例如 less)。此行为可以通过 --paging 选项进行控制。

当管道传输到另一个进程或重定向到文件时,bat 会自动检测到这种情况并禁用分页。

来源: README.md55-64

命令行选项

bat 提供了许多选项来自定义其行为。

选项描述
-A, --show-all显示不可打印字符
-p, --plain显示纯文本样式(无装饰)
-l, --language设置语法高亮语言
-H, --highlight-line高亮显示特定行
-n, --number显示行号
-d, --diff仅显示已添加/删除/修改的行
--tabs设置制表符宽度
--wrap指定文本换行模式
--color何时使用颜色
--theme设置语法高亮颜色主题
--style设置要显示的样式组件
-r, --line-range仅打印特定行

有关选项的完整列表

来源: README.md521-537 tests/syntax-tests/source/cmd-help/test.cmd-help1-44

与其他工具的集成

bat 可以与各种命令行工具集成以增强其功能。

fzf 集成

您可以使用 bat 作为 fzf 的预览器。

来源: README.md112-123

与文件查找器集成

find

fd

来源: README.md125-137

ripgrep 集成

使用 batgrep 显示具有语法高亮功能的搜索结果。

来源: README.md139-146

git 集成

查看文件的旧版本并进行语法高亮

查看代码更改周围的行并进行语法高亮

来源: README.md158-176

其他集成

  • 用于监控文件的 tail -f,支持语法高亮
  • 用于复制文件内容(不带行号)的 xclip
  • 用于彩色 man 页面的 man
  • 用于显示格式化代码的 prettier/shfmt/rustfmt

来源: README.md147-235

配置

来源: README.md700-739

配置文件

bat 可以通过配置文件进行自定义。要查找默认位置,

您还可以使用 BAT_CONFIG_PATH 环境变量设置自定义位置。

生成默认配置文件

配置文件是简单的命令行参数列表。

来源: README.md700-739

自定义语法高亮

您可以通过更改主题来定制语法高亮。

在配置文件或环境变量中设置永久主题。

来源: README.md480-499

添加新的语法和主题

添加新的语法定义

添加新主题

来源: README.md539-597

自定义分页器

bat 使用 PAGER 环境变量指定的分页器(默认为 less)。您可以通过 BAT_PAGER 变量覆盖此设置

或者在配置文件中设置

来源: README.md627-672

平台特定考量

Windows 特定设置

在 Windows 上,请考虑以下附加步骤

  1. 安装一个合适的分页器,例如 less(Windows 只包含一个有限的 more 分页器)
  2. 如果使用较旧的 Windows 版本,请考虑使用 Cmder 以获得更好的颜色支持
  3. 对于 Cygwin 路径,请使用包装函数来转换路径

来源: README.md742-774

macOS 上的暗黑模式

在 macOS 上,您可以配置 bat 以根据操作系统主题使用不同的主题

来源: README.md688-696

故障排除

终端和颜色

为了获得最佳体验,请使用支持 24 位真彩的终端。如果您的终端颜色支持有限,请考虑使用 8 位主题之一

  • ansi(使用 3 位颜色)
  • base16(使用 4 位颜色)
  • base16-256(用于 base16-shell)

来源: README.md800-811

行号和网格可见性

如果行号和网格难以看到,请尝试其他主题

来源: README.md813-815

文件编码问题

bat 原生支持 UTF-8 和 UTF-16。对于其他编码,请先转换为 UTF-8

来源: README.md817-827