跳到主要内容

文档检索

v3.0.0+

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

tcb docs 在终端内检索和阅读 CloudBase 官方文档，不需要打开浏览器。

列出文档模块​

tcb docs list

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

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

读取文档​

tcb docs read <模块名 | 路径 | 标题 | URL>

参数说明：

参数说明必填
<模块名>一级模块名，输出该模块的文档目录是
<路径>层级路径，格式为 a.b.c，如 MySQL数据库.数据操作.字段类型是
<标题>文档标题，按标题匹配是
<URL>文档站地址，如 https://docs.cloudbase.net/cli-v1/functions/deploy是

四种写法任选一种，四种都传不匹配的内容时命令报错。

使用示例：

# 先列出模块
tcb docs list

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

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

# 按标题读取
tcb docs read 云函数部署

# 按 URL 读取
tcb docs read https://docs.cloudbase.net/cli-v1/functions/deploy
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 <关键词>关键词搜索文档

注意事项​

  • 文档内容通过云开发接口检索，需要网络连接
  • 加上 --json 后输出结构化结果，便于脚本处理
  • 命令不读取本地登录态，未登录也能使用