CLI Guide

本書では、KAMONOHASHIのコマンドラインツールをインストールして使用するまでの手順を説明します。

前提

読者がLinux、Windows の基本的な知識を持つことを前提としています。

また、CLIの動作確認済み環境を下表に示します。 OSには動作確認済みの Python および pip がインストールされており、パスが通っていることを確認してください。

項目	バージョン
OS	Ubuntu 18.04、Windows 10
Python	3.5以上

CLIの使用方法

CLIインストール

インストールコマンド

端末のコンソールから以下のコマンドを実行します。

> pip install kamonohashi-cli

• なお、KAMONOHASHI のアプリのバージョンに合った CLI のバージョンをインストールすることが望ましいです。
• 上のコマンドでは、リリースされている最新バージョンの CLI がインストールされるため、バージョンを指定したインストールを行う場合は以下のコマンドを実行します。

> pip install kamonohashi-cli==<任意のバージョン>

初期設定

CLIを利用するために、KAMONOHASHI にログインします。

> kqi account login

上記コマンドを実行すると、サーバ名、ユーザ名、パスワードの入力プロンプトが表示されます。必要な情報を入力し、ログインすると以降必要な設定情報が書き込まれて CLI が利用可能となります。サーバ名等の情報は管理者より提供されます。

CLI使用方法

KAMONOHASHIのコマンドは

> kqi <サブコマンド> <操作> オプション

という構成になっています。 コマンドの使用方法はヘルプオプション(-h)で確認できます。

> kqi -h

下表に一覧と概要を示します。

コマンド	説明
kqi account	アカウントに関連するコマンド
kqi data	データの登録・更新・削除などを行うコマンド
kqi dataset	データセットの登録・更新・削除などを行うコマンド
kqi inference	推論の登録・更新・削除などを行うコマンド
kqi preprocessing	前処理情報の登録・更新・削除などを行うコマンド
kqi training	学習の作成・実行・停止などを行うコマンド
kqi tenant	テナントの作成・削除などを行うコマンド

また、各コマンドについても詳細をヘルプオプション(-h)で確認できます。 training コマンドの使用方法を確認している例を以下に挙げます。

> kqi training -h

コマンドの引数についても同様にヘルプオプションで(-h)確認できます。

> kqi training create -h