bat

bat 是一款用 Rust 编写的命令行文件查看工具,支持语法高亮、Git 版本差异标记、非打印字符显示、自动分页与多种终端工具集成。

开源项目

项目信息

文章目录

这是什么

bat 是一个用 Rust 编写的命令行文件查看工具,可以理解为“长出翅膀的 cat”。它保留 cat 的基本使用习惯,同时把阅读代码时最常用的能力直接放进终端:自动识别语言并高亮语法、标出文件相对 Git 索引的修改、显示不可见字符,以及在内容较长时自动分页。当前项目最新版本为 v0.26.1,采用 Apache-2.0 许可证,已获得 60993 个 Star。

它不是另一个编辑器,而是专门服务“看”的命令行工具。阅读源码、配置、文档或日志时,语法高亮能快速区分关键字、字符串和注释;Git 集成则借助 git 显示改动行;从标准输入读取时,还可以通过 shebang 判断语言。无法自动判断时,可用 -l 明确指定语言。

兼容性是 bat 的另一层设计。在交互式终端中,输出过长会交给分页器;一旦输出被重定向或送入管道,工具便退回纯文本模式,不附加行号、装饰或颜色。这样既适合交互阅读,也能继续承担创建文件、拼接文件和脚本传输等 cat 任务。

适合谁用

它尤其适合经常在终端里阅读源码的开发者。无论项目使用 Rust、Python、JavaScript,还是各种配置与标记格式,都能减少裸文本中辨认代码结构的负担。需要在 Git 仓库中快速确认某个文件改了什么的人,也能直接利用差异标记,而不必先打开完整差异页面。

系统管理员和技术团队同样可以把 bat 当作统一查看工具:查看日志时显式指定语言并关闭分页,排查配置时显示不可打印字符,或把它接入 fzf、find、fd、ripgrep、Git 和 man 的工作流。它不改变文件本身,更适合作为现有命令行习惯的增强层。

亮点

  • 语法高亮:自动识别大量编程语言和标记语言,也可通过 -l 指定类型,标准输入还可借助首行 shebang 判断。
  • Git 集成:读取索引差异并在侧边标记修改行,配合 --diff 可直接查看文件变更。
  • 非打印字符:-A 或 --show-all 能显示并高亮制表符、回车等不可见内容。
  • 自动分页:交互终端中内容过长时自动使用分页器,重定向时自动保持纯文本输出。
  • 工具组合友好:可作为 fzf 预览器,也能配合 find、fd、batgrep、tail -f、git show、git diff 与 man 使用。

怎么用

使用 Rust 工具链时,可以通过 Cargo 安装:

cargo install bat

bat --version
bat README.md
bat src/*.rs
bat -A /etc/hosts
bat --diff src/main.rs

bat --diff 需要在 Git 仓库中针对已有文件使用;查看单个文件可加 -n 仅显示行号,指定语言则使用 -l。例如,下面的命令分别显式采用 JSON 和 Rust 语法:

bat -l json config.json
bat -l rs src/main.rs

从标准输入读取时,如果首行是 shebang,通常可以自动识别;也可以继续用 -l 指定。若要始终像 cat 一样不分页,可加入 --paging=never。与 fzf 集成时,可强制颜色并只预览前 500 行:

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

注意事项

  • 部分较旧的 Debian 或 Ubuntu 软件包会把可执行文件命名为 batcat,而不是 bat,使用时需留意命令名差异。
  • 重定向或管道输出默认是纯文本;若集成场景必须保留颜色,应显式使用 --color=always。若将 shell 的 cat 别名替换为 bat,建议写成 alias cat='bat --paging=never',以保留原有行为。

国内镜像下载

这个项目已经镜像到站长自己的服务器,GitHub 打不开、或者下载太慢的时候,直接从这里拿。

项目与资料

整理自本文的外部链接,请以来源页面说明为准。

bat · 阿凡达博客