Skip to content
happy-protoPublic

About

A syntax-highlighting cat built around Tree-sitter.

Resources

Stars

2 stars

Watchers

0 watching

Forks

Repository files navigation

Kat

build dependency status license

kat 是一个基于 Tree-sitter 的终端文件查看工具,支持高亮阅读和两栏目录浏览。

它最在意的是嵌套语言:Rust 文档注释里的 Markdown、Markdown 代码块里的 Mermaid、Justfile 和 mise / hk 配置里的脚本,都能按各自的语言高亮。也支持直接查看图片。

这个项目源于我使用 bat 时对嵌套高亮的需求,实现中参考了 Zed 的语言支持。它是一个个人玩具,完全 vibe Coding,基本不 Review。

安装

推荐使用 cargo-binstall 下载预编译二进制:

cargo binstall --git https://github.com/happy-proto/kat kat

也可以从源码安装。macOS 仅支持 Apple Silicon。

源码构建与预编译包统一使用 kat-parsers 的预生成压缩语法表,无需额外启用压缩 feature 或预处理依赖源码。

latest 发布说明按平台和架构展示安装后的二进制体积,单位为 MiB,方便比较各发布包内可执行文件的大小。

使用

kat
kat path/to/directory
kat path/to/file
kat path/to/image.png
kat --stdin

在终端中直接执行 kat 等同于 kat .:左侧浏览文件,右侧预览内容;用 hjkl 或方向键导航,Enter 或 l/→ 打开全文,退出阅读后回到目录。按 / 使用 fzf 算法筛选文件名并高亮命中字符,首次 Enter 提交筛选词,再次 Enter 打开选中项。指定文本文件会直接进入内建 viewer,支持滚动、搜索和刷新;q 退出。显式读取标准输入使用 kat --stdin,管道输入仍自动读取 stdin,文件内容通过管道或重定向输出时保持完整输出。

目录浏览使用 Dracula 配色,默认显示 Nerd Font 文件图标;终端需支持对应字体,也可用 --icons=never 关闭图标。详见目录浏览。

全文查看与目录浏览使用同一套界面样式,路径与操作信息统一放在底部状态栏,home 路径前缀缩写为 ~。Enter 或 l/→ 查看选中项,全文查看中 h/← 返回目录。安装 shell 集成后,按 o 退出 kat 并让 shell 进入选中目录,O 则进入当前正在浏览的目录。

继续了解

About

A syntax-highlighting cat built around Tree-sitter.

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages