跳到主要内容

文档检索

v3.0.0+

tcb docs 命令自 v3.0.0 起提供，无需登录即可使用。

tcb docs 用于在终端内直接检索和阅读 CloudBase 官方文档，无需打开浏览器。

列出所有文档模块​

列出 CloudBase 文档站中的所有一级业务模块：

tcb docs list

示例输出：

文档站业务模块列表：
  01  云函数
  02  数据库
  03  云存储
  04  云托管
  05  MySQL数据库
  ...

读取文档内容​

读取指定模块或文档的详细内容。支持多种输入方式：

# 读取模块的文档目录
tcb docs read <模块名>

# 按层级路径读取（a.b.c 格式）
tcb docs read MySQL数据库.数据操作.字段类型

# 按文档标题搜索
tcb docs read 云函数部署

# 直接读取文档 URL
tcb docs read https://docs.cloudbase.net/cli-v1/functions/deploy

示例：

# 先列出模块
tcb docs list

# 读取「云函数」模块的文档目录
tcb docs read 云函数

# 按路径读取具体文档
tcb docs read 云函数.部署.快速开始

关键词搜索文档​

按关键词搜索文档，返回相关文档列表：

tcb docs search <关键词>

示例：

# 搜索云函数相关文档
tcb docs search 云函数部署

# 搜索 MySQL 相关文档
tcb docs search MySQL 备份

示例输出：

搜索结果（3 条）：

  01  部署云函数
      https://docs.cloudbase.net/cli-v1/functions/deploy
      使用 tcb fn deploy 命令可以快速部署云函数到云开发环境…

  02  函数配置
      https://docs.cloudbase.net/cli-v1/functions/configs
      cloudbaserc.json 中云函数的配置项说明…

典型使用流程​

# 1. 不知道有哪些模块？先列出全部
tcb docs list

# 2. 选择感兴趣的模块，查看其文档目录
tcb docs read 数据库

# 3. 找到具体文档后读取内容
tcb docs read 数据库.数据模型管理

# 4. 不确定路径？用关键词搜
tcb docs search 数据模型 pull

命令速查​

命令说明
tcb docs list列出所有一级文档模块
tcb docs read <路径|标题|URL>读取文档内容
tcb docs search <关键词>关键词搜索文档