Lib.rs

通过命令行和脚本使用 Zenkit。读取和更新工作区、列表、项目、字段和 webhook；并执行 json 备份。

安装

使用 cargo install zenkit-cli 进行安装。程序名称为 zk（通常安装到 $HOME/.cargo/bin）。安装 cargo 的说明请见此处

将环境变量 ZENKIT_API_TOKEN 设置为您的 API 令牌，您可以从 Zenkit 账户中获取（即使是免费套餐）。

可选：为了避免为最常用的工作区重复输入 --w WORKSPACE，将环境变量 ZENKIT_WORKSPACE 设置为工作区名称。始终使用 --w WORKSPACE 选项覆盖 ZENKIT_WORKSPACE。

zk 使用方法

使用 zk --h 查看帮助。

对于下面的命令，workspace、list 或 field 的参数值可以是对象的 ID（整数）、UUID 或显示名称。包含空格或符号的值应加引号。

除 workspaces 以外，所有命令都需要一个 --w workspace 参数或需要环境变量 ZENKIT_WORKSPACE 包含工作区名称。以下省略了 -w 选项以节省篇幅。

• 显示帮助
  zk-h/--help

• 工作区命令

  • 显示所有工作区和列表（可通过您的用户访问）
    zk workspaces
    输出列（以制表符分隔）

    • W/L：工作区或列表
    • id：对象 ID（正整数）
    • uuid：对象 UUID
    • name：对象名称

  • 显示工作区中的用户
    zk users
    输出列（以制表符分隔）

    • id
    • uuid
    • name

  • 显示工作区中的列表
    zk lists
    输出列（以制表符分隔）

    • id
    • uuid
    • name

• 列表命令

  • 显示列表中的项目
    zk items-l list
    输出列（以制表符分隔）
    • id
    • uuid
    • name

• 列表字段/模式命令

  • 显示列表的字段
    zk fields-l list
    输出列（以制表符分隔）

    • id
    • uuid
    • name

  • 显示字段的选项值
    zk choices-l list-字段 f
    输出列（以制表符分隔）

    • id
    • name

  • 描述字段
    zk 字段-l list-字段 f
    输出格式：文本对象转储

• 项目命令

  • 显示项目详情
    zk 项目-l list-i 项目编号
    输出格式：对象转储（文本）

  • 设置字段值
    zk 设置-l list-i 项目编号-字段 f[-t 文本] [-v 值| -F 文件]
    

    值可以指定在命令行（-v）或从文件（-F）中。

    对于类型为人的字段，值可以是该人的 uuid 或显示名称（不区分大小写）。对于类型为选择的（类别）字段，值可以是选择 id、uuid 或显示名称（区分大小写）。对于类型为引用的字段，值必须是相关对象的 uuid。

  • 创建项目
    zk 创建-l list-F 字段=值-F 字段=值...jj
    

    值可以是上述“设置字段值”中描述的格式。字段名称可以是 id、uuid 或显示名称（区分大小写）。

  • 向项目添加注释
    zk 注释-l list-i 项目-c 注释

• 网络钩子

  • 添加网络钩子
    zk 网络钩子--类型 触发器-类型 --url url[ OPTIONS ]

  • 删除网络钩子
    zk 删除-网络钩子--网络钩子 网络钩子

  • 列出网络钩子
    zk 列出-网络钩子

• 备份

  • 将列表和字段定义备份到 json 文件中
    zk 备份-o 输出目录[ -l list]
    如果没有指定列表，将备份工作区中的所有列表。