コマンドラインツールガイド

アプリ開発のお手伝いをするために Kii Cloud はコマンドラインツールを提供しています。

コマンドラインツールが提供する機能は以下の 2 つです。

  1. サーバー機能拡張の管理:サーバー機能拡張 を利用する際に必要となる Server Code が管理できます。コマンドラインツールを利用することで、Server Code の設置やバージョン管理が行えます。

    詳しくは Server Code を管理する を参照してください。

  2. 開発者ログの閲覧(ベータ版):Kii Cloud 上のサーバーログが確認できます。ログ確認の際には、ログレベルやログ出力日時などのフィルターによる絞り込みができます。

    詳しくは 開発者ログの閲覧 を参照してください。

コマンドラインツールのインストール

コマンドラインツールは、開発者ポータルよりダウンロードできます。

  1. 開発者ポータルにおいて "ダウンロード" をクリックします。

  2. コマンドラインツールの ZIP ファイルをダウンロードします。

  3. ダウンロードした ZIP ファイルを解凍して、作成されたディレクトリに移動します。
    ZIP ファイルには以下のファイルが含まれています。

    • kii-logs.js:開発者ログを閲覧するためのコマンド本体
    • kii-servercode.js:サーバー機能拡張を管理するためのコマンド本体
    • format.json:ログの表示フォーマットを制御する設定ファイル
    • package.json:依存モジュールを管理している npm 設定ファイル
  4. 実行に必要なソフトウェアをインストールします。

    Windows の場合:

    • Node.js をインストールします。v0.12.13 での動作実績があります。
    • Python をインストールします。v2.7.9 での動作実績があります。
    • Visual Studio をインストールします。Windows 10 では、Visual Studio Community 2015 での動作実績があります。

    Mac の場合:

    • Node.js をインストールします。v0.10.35 での動作実績があります。
    • 必要なソフトウェア(Python、make、gcc)はデフォルトでインストールされています。Node.js 以外のインストールは特に不要です。

    Node.js 以外のビルド環境の詳細は、コマンドラインツールが内部で利用している node-gyp の README をご覧ください(node-gyp 自体の導入作業は不要です)。

  5. コマンドラインツールを以下のコマンドでインストールします。

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

    xxxxx には、コマンドラインツールのビルドバージョンを表す文字列が入ります。

    実行中、エラーメッセージが出力されますが、node bin/kii-servercode.js と入力して以下のような使用方法が表示されれば正常に動作しています。

    $ 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 の指定が必要です。これらの値は、開発者ポータルのアプリケーション画面で確認できます。

確認方法は アクセスキーの確認とリセット をご覧ください。