命令行使用¶

$ rtfd cfg -h
查询配置文件的配置内容

Usage:
  rtfd cfg [flags]

Flags:
  -h, --help   help for cfg
  -j, --json   使用JSON格式显示结果

Global Flags:
  -c, --config string   rtfd配置文件 (default "/root/.rtfd.cfg")

$ rtfd cfg default
map[base_dir:/rtfd favicon_url:https://static.saintic.com/rtfd/favicon.png redis:redis://:123456@localhost/0 unallowed_name:]

$ rtfd cfg default -j   # 以下输出为jq格式化排版后
{
  "base_dir": "/rtfd",
  "favicon_url": "https://static.saintic.com/rtfd/favicon.png",
  "redis": "redis://:123456@localhost/0",
  "unallowed_name": ""
}

$ rtfd cfg default redis -j
"redis://:123456@localhost/0"

$ rtfd cfg default redis
redis://:123456@localhost/0

$ rtfd p create -h
创建文档项目

Usage:
  rtfd project create [flags]

Flags:
  -u, --url string           文档项目的git仓库地址，如果是私有仓库，请在url协议后携带编码后的 username:password
      --latest string        latest所指向的分支 (default "master")
      --single               是否为单一版本
  -s, --sourcedir string     实际文档文件所在目录，目录路径是项目的相对位置 (default "docs")
  -l, --lang string          文档语言，支持多种，以英文逗号分隔 (default "en")
  -v, --version uint8        构建文档所用的Python版本，2或3 (default 3)
  -r, --requirement string   需要安装的依赖包需求文件（文件路径是项目的相对位置），支持多个，以英文逗号分隔
      --install              是否需要安装项目
  -i, --index string         指定pip安装时的pypi源
  -b, --builder string       Sphinx构建器，可选html、dirhtml、singlehtml (default "html")
      --secret string        Api/Webhook密钥
      --domain string        自定义域名
      --sslcrt string        自定义域名的SSL证书公钥
      --sslkey string        自定义域名的SSL证书私钥
      --before string        构建前的钩子命令
      --after string         执行构建成功后的钩子命令
  -h, --help                 help for create

Global Flags:
  -c, --config string   rtfd配置文件 (default "/root/.rtfd.cfg")

$ rtfd p create -u https://github.com/user/repo test

更新文档项目配置

第一种方式，通过 text 选项：

仅可更新部分字段，参考如下列表（即Field，解释说明处小括号为字段类型，无则默认为string）：

url：        文档项目的git仓库地址
latest：     latest所指向的分支
version：    构建文档所用的Python版本，2或3（int）
single：     是否单一版本（bool）
source：     文档源文件所在目录
lang：       文档语言
requirement：依赖包需求文件，支持多个，以逗号分隔
install：    是否安装项目（bool）
index：      pypi源
builder：    sphinx构建器
shownav：    是否显示导航（bool）
hidegit：    导航中是否隐藏git信息（bool）
secret：     api/webhook密钥
domain：     自定义域名
sslcrt：     自定义域名开启HTTPS时的证书公钥
sslpri：     自定义域名开启HTTPS时的证书私钥
before：     构建前的钩子命令
after：      执行构建成功后的钩子命令
meta：       额外配置数据，每次仅能更新一条，格式是 key=value（key不区分大小写）

可一次更新一个或多个字段，格式是 -> Field:Value,Field:Value,...,Field:Value
分隔符可用 sep 选项设置，更新成功或失败的字段均会打印。
请按照字段类型（如int、bool）填写值，否则可能导致异常。
请注意：
    # bool类型仅当值为1、true、on时表示true，其他表示false
    # domain字段值为0、false、off时表示取消自定义域名（不更改SSL相关配置）
    # 额外字段ssl（不在列表中）值为0、false、off时表示取消自定义域名SSL
    # 部分更新失败的字段亦可能已造成破坏性更改（如lang、latest、domain）
    # 部分字段仅在下一次构建时生效
    # 特殊字段meta系统内置字段：
        # _sep: 当meta内部字段的值为多值类型时，指定其分隔符，默认是 |

第二种方式，通过 file 选项：

通常用于构建时更新，编写 rtfd.ini 规则文件放到源码仓库中，在构建时 rtfd 会读取此文件，
结合系统存储配置（优先级低于规则文件）进行参数化文档构建。

不过相对于第一种方式，此方式可更新字段较少，仅为构建时参数。

Usage:
  rtfd project update [flags]

Flags:
  -f, --file string   更新规则文件
  -h, --help          help for update
  -s, --sep string    设定 Field、Value 之间的分隔符 (default ":")
  -t, --text string   更新规则文本，格式是 Field:Value,Field:Value

Global Flags:
  -c, --config string   rtfd配置文件 (default "/root/.rtfd.cfg")

$ rtfd p update -t url=https://github.com/USER/REPO,hidegit=true -s = test

$ rtfd p update -t before:"make build-css" test

$ rtfd p t -h
转储（导入、导出）文档项目

可以使用此之命令在一台服务器上将项目配置导出为 base64 编码的字符串，
在另一台服务器上导入，或者在本地导入（相当于复制项目，需要设置别名）。

导出：

    $ rtfd p t -e <NAME>
    // Output: base64-encoded

导入：

    $ rtfd p t -i <base64-encoded>

    // 因为导出选项包含名称，如果导入时rtfd已经有此名称则会失败，
    // 此时可以设置别名覆盖原名称。
    $ rtfd p t -i <base64-encoded> <New-Name>
    // Output: imported (if success)

Usage:
  rtfd project transfer [flags]

Aliases:
  transfer, t

Flags:
  -e, --export          导出项目
  -h, --help            help for transfer
  -i, --import string   导入（格式为 base64 编码）项目
  -d, --import-debug    不导入项目，仅查看选项

Global Flags:
  -c, --config string   rtfd配置文件 (default "/home/taochengwei/.rtfd.cfg")

$ rtfd p t -i $(rtfd p t -e <OldName>) <NewName>