CLIツールの基本操作

Hexabase CLI(Command Line Interface) は、開発者が Hexabase のデータ操作をより容易に行うための、開発者向け補助ツールです。npm にて公開されており、誰でも自由に利用できます。

npm#

https://www.npmjs.com/package/hexabase-cli

あらかじめ用意するもの#

  • node.js
  • npm

インストール#

$ npm install -g hexabase-cli

アップデート#

$ npm update -g hexabase-cli

使い方#

$ hx COMMAND
| running command...
$ hx (-v|--version|version)
| hexabase-cli/0.0.2 darwin-x64 node-v14.13.0
$ hx --help [COMMAND]
| USAGE
| $ hx COMMAND

コマンドリスト#

こちらをご覧ください。

環境設定(初回のみ)#

初回のみ、以下の環境設定コマンドを実行します。

CLIでは、アクセス先の環境は コンテキスト(context) と呼ばれる単位で管理しています。

コンテキストは、次のコマンドで設定します。

$ hx contexts:set [CONTEXT]
ARGUMENTS
| CONTEXT context name
OPTIONS
| -h, --help show CLI help
| --server=server API server, e.g. https://api.hexabase.com
| --sse=sse SSE server, e.g. https://sse.hexabase.com

次の例では、利用している開発環境を指定して、「stg」と命名しています。

$ hx contexts:set stg --server=https://az-api.hexabase.com --sse=https://az-sse.hexabase.com

コンテキスト#

コンテキストの確認

$ hx contexts:get
| NAME  SERVER               SSE
| stg  https://az-api.hexabase.com   https://az-sse.hexabase.com

複数コンテキストを確認できる

$ hx contexts:get
| NAME  SERVER               SSE
| stg  https://az-api.hexabase.com   https://az-sse.hexabase.com
| prod  https://api.hexabase.com    https://sse.hexabase.com

コンテキストの切り替え

$ hx contexts:use stg
| √ Select your current-context · stg
| Current-context successfully set to: stg

ログイン#

$ hx login
| ? Enter your email » myname@my-corp.com
| ? Enter your password » xxxxx
| Successfully logged in as: myname@my-corp.com

※Hexabase CLI でログインするには、あらかじめ Hexabase のユーザーアカウントを取得しておく必要があります。

ワークスペース#

ワークスペースの確認

$ hx workspaces:get
| ID NAME
| 5ea81d61a7e3860007bcbe2b workspace_1
| 5e9678e8d4b3e00006eb8745 workspace_2
| 5e1471ac77dc58000633ea84 workspace_3

ワークスペースの選択

$ hx workspaces:use 5e1471ac77dc58000633ea84
| Current-workspace set to: workspace_3