官方网站：https://cli.kintone.dev/

在 kintone 上，汇入汇出资料或大量删除纪录是常见需求。虽然系统提供部分功能，但像附件汇出入或条件式大量删除这类进阶操作，网页介面并不支援。虽然可以透过开发处理，但对于没有开发背景的使用者来说，这根本就是一件不可能的任务。

为此，cybozu 开发了 cli-kintone 工具。即使没有开发背景，使用这个工具也能轻鬆管理 kintone 资料。这篇文章将教你如何安装 cli-kintone。

如何安装 cli-kintone

直接到官网上的 安装页面 中，会看到两种安装方式，分别是：

  • 使用二进制档案 (Binary file)
  • 使用 npmjs.com 安装

    • 以下将分别以 Windows 和 MacOS 示范。

    使用 Binary file 安装（Windows 范例）

    这个方法较为简单，几乎是开箱即用，我们用 Window 安装。

  • 首先前往 Github Release 的页面，下载最新版 cli-kintone，写文的当下是版本 v1.13.0。往下滚动找到 Assets 中的 cli-kintone_v1.13.0_win.zip 档案：
  • 下载后并且解压缩，会得到如下图的资料夹：
  • 接着在这个目录底下打开终端机，如上图在路径上输入 cmd，并在终端机输入以下：

    • cli-kintone.exe

    没意外就会出现跟下图一样的结果：

    到这边就成功了，后续就能使用指令操作，需要注意的是这个 .exe 档案的路径在哪里。

    使用 npm 安装（MacOS 范例）

    接着换 MacOS 使用 npm 安装：

  • 首先下载 Node.js。点选下方的网站进入 Node.js 官网，点击「下载 Node.js（LTS）」，之后一路点下一步安装到底。

    • 网址：https://nodejs.org/zh-tw

  • 安装完成后，开启终端机，输入以下指令确认 npm 是否正常运作：
  • 接着在终端机内再次输入以下，这个指令代表要将 cli-kintone 安装到电脑的全域上，我们就可以在电脑的任何地方输入指令调用 cli-kintone 的功能：

    • sudo npm install @kintone/cli --global

    最后在终端机内输入 cli-kintone，如果跳出以下代表顺利安装成功了：

    设定成环境变数

    如果用 Binary file 的话，每次都要记住档案位置，或者是要 cd 进来，稍嫌麻烦了点，所以我们直接将 cli-kintone 加进环境变数，就可以直接打开终端机执行了。

    MacOS

    直接将 cli-kintone.exe 档案放到路径 /usr/local/bin 底下，完成！

    Windows

    ⚠️ 以下截图都是英文，请依照个人系统的语言服用。

    首先在电脑搜寻「环境变数」，并打开：

    打开后会出现以下画面，接着做以下步骤：

  • 点选环境变数
  • 按下 PATH
  • 按下编辑
  • 新增 cli-kintone 二进制档案的路径
  • 按下确定，其他的关闭前也都要按

    • 如此一来就可以直接打开终端机，在任何路径都能输入 cli-kintone并执行。

    指令自动补全（Command completion）

    cli-kintone 也有支援自动补全，按下 tab 后可以选择跳出来的提示，不用再自己手打或是去官网找指令。目前有支援 zsh 和 bash。

    以下是 MacOS 的安装方式，打开 cli-kintone.exe 存在的资料夹（资料夹名称不要含空白），并且依序输入以下：

    zsh

    # 1. Set PATH environment variables
    echo "export PATH=$(pwd):\\$PATH" >> ~/.zshrc

    # 2. Create and configure a directory to store the completion scripts
    mkdir -p ~/.zsh_completion.d/
    echo \'fpath=(~/.zsh_completion.d $fpath)\' >> ~/.zshrc

    # 3. Enable bash-autocomplete feature
    echo \'autoload bashcompinit && bashcompinit\' >> ~/.zshrc
    echo \'autoload -Uz compinit && compinit\' >> ~/.zshrc

    # 4. Create command completion script
    ./cli-kintone completion >> ~/.zsh_completion.d/_cli-kintone

    # 5. Reload zsh
    source ~/.zshrc

    bash

    # 1. Create command completion script
    mkdir -p ~/.bash_completion.d
    ./cli-kintone completion >> ~/.bash_completion.d/_cli-kintone

    # 2. Add command completion script to bash

    # For login shell
    echo "export PATH=$(pwd):\\$PATH" >> ~/.bash_profile
    echo \'source ~/.bash_completion.d/_cli-kintone\' >> ~/.bash_profile
    source ~/.bash_profile

    # For non-login shell
    echo "export PATH=$(pwd):\\$PATH" >> ~/.bashrc
    echo \'source ~/.bash_completion.d/_cli-kintone\' >> ~/.bashrc
    source ~/.bashrc

    Windows

    Windows 需要用 WSL（Windows Subsystem for Linux），直接操作以下即可：

  • 使用 WSL 在 Windows 上安装 Linux。
  • 打开 Linux 终端机。
  • 从 Linux 套件中下载并解压执行档。
  • 执行与 bash 部分相同的命令。

    • 成功后，就可以使用 tab 键触发补全：

    cli-kintone 补全范例影片：https://i.imgur.com/TGjBjcR.mp4

    以上就是 cli-kintone 的安装指南，下篇文章会接着讲解如何操作该工具。