ドキュメントを検索

解説 Geolonia CLI とは

Geolonia CLI は、コマンドラインから Geolonia のアカウント上のものを操作する公式ツールです。地図を描くためのライブラリ(embed / maps-suite / maps-react)とは役割が別で、こちらは地図を描く前の準備と運用を担います。

いま CLI で行えるのは次の 2 つです。

管理画面でも同じことができますが、CLI が向いているのは手順を再現したいときです。キーの構成をファイルに書いて差分を見てから適用する、といった運用ができます。

インストール

Node.js が必要です。22.0.0 以上を使ってください。

npm install --global @geolonia/cli

geolonia コマンドが入ったか確認します。

geolonia --version

ログインとチームの選択

CLI の各コマンドは、ログイン済みであることと、対象のチームが選ばれていることを前提にしています。

geolonia login
geolonia teams select

geolonia teams select は所属チームの一覧を出して番号で選ばせます。チーム ID が分かっているなら geolonia teams select <teamId> と直接渡せます。

いま誰としてログインしているかは次で確認できます。

geolonia whoami

設定と資格情報の置き場所

ファイル内容
~/.config/geolonia/credential.ymlユーザー名とリフレッシュトークン
~/.config/geolonia/config.yml選択中のチーム

どちらも --credential-file--config-file で別のパスを指定できます。1 台のマシンで複数のチームやアカウントを切り替える場合に使います。

資格情報の扱い

credential.yml にはリフレッシュトークンが入ります。リポジトリに含めたり、共有マシンに置いたままにしたりしないでください。

コマンド一覧

コマンド何をするか
geolonia loginログインしてトークンを保存する
geolonia teams list所属チームを一覧する
geolonia teams select [teamId]操作対象のチームを選ぶ
geolonia user show / whoami / meいまのユーザー情報を表示する
geolonia map-keys listAPI キーを一覧する
geolonia map-keys show <keyId>API キーの詳細を表示する
geolonia map-keys search <query>名前や許可オリジンでキーを検索する
geolonia map-keys newAPI キーを新しく作る
geolonia map-keys add-origin <keyId> <origin>許可するオリジンを足す
geolonia map-keys remove-origin <keyId> <origin>許可するオリジンを外す
geolonia map-keys pull現在のキー構成を YAML に書き出す
geolonia map-keys plan -f <file>YAML と現状の差分を表示する
geolonia map-keys apply -f <file>YAML の内容を反映する
geolonia plan showいまのプラン、当月の地図表示回数、quota を表示する
geolonia plan list利用できるプランの一覧を表示する
geolonia generate-access-tokenチームのアクセストークンを発行する

geolonia map-keys delete <keyId> は用意されていますが、実行するとダッシュボードで消すよう案内して終わります。キーを消すと、そのキーを使っている地図が一斉に止まるためです。

geolonia plan showgeolonia plan list0.4.0 以降で使えます。それより古い版では unknown command 'plan' になるので、geolonia --version を確認してください。

プランと利用量を見る

geolonia plan show

選択中のチームについて、いまのプラン、当月の地図表示回数、quota を表示します。ダッシュボードを開かずに使用量を確認できます。

geolonia plan list

利用できるプランの一覧(プラン名、料金、含まれる地図表示回数、メンバー上限)を表示します。このコマンドだけはログイン不要です。契約前に比較できます。

CI から使う

geolonia generate-access-token は、保存済みのリフレッシュトークンからチームのアクセストークンを発行します。対話的なログインを挟めない環境(CI など)で、トークンを環境変数に渡して使うことを想定したコマンドです。

関連