命令行工具指南

我们提供了命令行工具,用于帮助开发人员与 Kii Clouod 交互

当前有2个可用的命令行工具。

  1. 管理服务端扩展: 为了使用 服务端扩展,你将需要为你的应用程序管理服务端代码。通过使用命令行工具,你可以安装服务端代码,同时对已部署的服务端代码做版本控制。

    详见 管理服务端代码

  2. 检查开发者日志(测试版): 当使用该命令行工具来检查位于 Kii Cloud 上的服务端日志时,您可以通过过滤日期、日志级别、用户等来颗粒化日志的输出。

    详见 查阅开发者日志

安装命令行工具

命令行工具的安装十分简单,只需几个步骤便可完成。 你可以在 开发者平台 下载命令行工具。

  1. 在开发者平台上,打开 "下载" 面板。

  2. 点击 "服务端扩展(Server Extension)" 图标并下载 ZIP 文件。

  3. 解压下载的 ZIP 文件并在你的终端(Terminal)上打开目录。

    Developer Log 目录应该包含如下文件:

    • kii-logs.js: 该 node.js 脚本是 CLI 的主要部分,用于检索日志数据。
    • kii-servercode.js: 该 node.js 脚本是 CLI 的主要部分,用于管理服务端代码。
    • format.json: 配置文件,用于定义日志信息的输出格式。
    • package.json: NPM 安装文件。
  4. 安装工具运行所需的模块。

    Windows:

    • 安装 Node.js (v0.12.13 已确认可用)。
    • 安装 Python (v2.7.9 已确认可用)。
    • 安装 Visual Studio (2015 Community 已确认在 Windows 10 上可用)。

    Mac:

    • 安装 Node.js (v0.10.35 已确认可用)。
    • 默认情况下,其他软件 (即, Python、make 和 gcc) 应该已经安装。所以只需要安装 Node.js 即可。

    请参照 node-gyp 的 README 了解更多关于所需环境的信息 (node-gyp 是我们命令行工具内部所使用的模块,所以你无需安装它)。

  5. 在终端运行以下命令安装命令行工具。

    $ cd kii-cli-latest-xxxxx
    $ npm install
    

    此处的 xxxxx 乃是命令行工具的编译版本。

    在控制台中输入 node bin/kii-servercode.js。即使你在安装过程中看到了错误消息,但是如果显示的 Usage 信息如下所示,则也表明工具已经安装成功。

    $ node bin/kii-servercode.js
    
      Usage: kii-servercode.js [options] [command]
    
      Commands:
    
      deploy-file [options]
      get [options]
      get-hook-config [options]
      list [options]
      delete [options]
      set-current [options]
      list-scheduled-execution [options]
      get-scheduled-execution [options]
      ...
    

用于执行命令的参数

命令行需要你提供 AppID、AppKey、ClientID 以及 ClientSecret 作为参数。您可以从开发者平台得到它们。

  1. 在应用程序展板中点击 "Key" 图标将展示 AppID 和 AppKey。

  2. 点击下方的按钮将展示 ClientID 和 ClientSecret。