Crib 是什么
Crib 解决什么问题、适合谁用,以及它和在线手册、Dash 这类工具的区别。
Crib 是一款 macOS 应用,把 PostgreSQL 6.3 到 20devel 共 31 条版本线的中英文手册、一份结构化的 PostgreSQL Wiki,以及你自己的笔记和更正放在同一个本地资料库里。它不需要账号,不依赖网络,也不需要连接 PostgreSQL 服务器。

它解决什么问题
查 PostgreSQL 文档时常见的几个麻烦:
- 版本对不上。 生产库还在 9.6 或 12,网上搜到的却是最新版手册。Crib 收录每条版本线,搜索时可以直接写
PG96: vacuum。 - 符号搜不到。
->>、@@、\dC这类写法在通用搜索引擎里会被当成标点丢掉。Crib 先按精确名称匹配,再搜正文。 - 中英文来回找。 读中文手册遇到拿不准的句子,想看英文原文,往往要重新翻目录。Crib 一键切到另一种语言的同一节,也可以两栏对照。
- 断网或内网环境。 机房、飞机、隔离网络里打不开在线文档。Crib 首次启动就能离线阅读和搜索。
- 笔记散落各处。 排障时记下的结论和手册原文分开放,过一阵就找不到出处。Crib 的笔记、书签和更正挂在具体章节上,内容更新后会重新核对位置,找不到的单独列出。
适合谁
| 读者 | 典型用法 |
|---|---|
| DBA / SRE | 输入 pg12: max_connections 或“锁”,确认某个版本的参数和行为,把结论记成笔记 |
| 应用开发者 | 查运算符、函数重载、psql 命令和 SQLSTATE,复制代码片段 |
| 中文读者与译者 | 读中文,遇到疑问切英文同节;对译文写本地更正并导出 |
| 维护老系统的人 | 对比旧版本和新版本的手册、版本发布与安全信息 |
和其他方式的区别
| 在线手册 | 下载 HTML 或 PDF | Crib | |
|---|---|---|---|
| 断网可用 | 否 | 是 | 是 |
| 31 条版本线 | 按版本分开浏览 | 需要逐个下载 | 同一个资料库 |
| 中英文同节切换 | 否 | 否 | 是,基于章节标识对应 |
| 跨版本搜索 | 依赖站内搜索 | 否 | 是,可按版本、语言、类型限定 |
| 笔记与更正 | 否 | 自行管理 | 挂在章节上,可导出 |
Crib 借鉴了 Dash 的片段库、系统服务和本地 API 等用法。区别在于内容格式:Crib 的 .crib 资料包自带双语章节对应、版本信息和签名,不使用也不兼容 Dash docset。
它不做什么
- 不连接数据库,不执行 SQL。
- 不翻译。中文内容只来自已有的中文译本;某一节没有译文时,明确显示缺失,不拿英文冒充。
- 不改写官方原文。你的更正存在个人资料库里,与原文并列显示。
- 没有云同步。个人资料可以导出、导入和备份,但不会自动上传到任何地方。
现在的状态
Crib 还在开发中,没有公开安装包。本站文档描述的是当前开发构建的行为。已经完成和尚未完成的部分见发布状态。