@geolonia/cli

CLI commands for Geolonia.

インストール方法

$ npm -g install @geolonia/cli

コマンド

共通オプション

$ geolonia <command> --credential-file <credentialFile>

認証情報はデフォルトでは ~/.config/geolonia/credential.ymlより読み込みますが、--credential-fileオプションにより、任意の場所に置かれたファイルを代わりに読み込むことができます。

$ geolonia <command> --config-file <configFile>

選択済みのチームなどの情報を保存しておく設定情報はデフォルトでは ~/.config/geolonia/config.ymlより読み込みますが、--config-fileオプションにより、任意の場所に置かれたファイルを代わりに読み込むことができます。

help

$ geolonia -h
$ geolonia --help

ヘルプを表示します。

version

$ geolonia -V
$ geolonia --version

バージョン番号を表示します。

user

ユーザープロフィールに関してのコマンド。

user show

$ geolonia user show [options]

ログイン中のユーザー情報（Name, Username, Email, Language, Timezone）を表示します。

whoami および me は user show のエイリアスです。

$ geolonia whoami
$ geolonia me

login

$ geolonia login

Geoloniaアカウント（https://app.geolonia.com/ で作成）でログインします。

各種コマンドを実行するには、事前にログインしておく必要があります。

認証情報（ログインしたときに得られるアクセストークンなど）は ~/.config/geolonia/credential.ymlに保存されます。

teams

チーム一覧、チーム選択のコマンド

teams list

$ geolonia teams list [options]

選択できるチーム情報の一覧を表示します。選択済みのチームには*マークが付きます。

teams select

$ geolonia teams select [options] <teamId>

teamIdを指定して、チームを選択します。

teamIdには、teams listコマンドで表示されるTeam IDを使用してください。

sprites

カスタムスプライトをアップロードするために使います。

sprites upload

$ geolonia sprites upload [options] <filePath>

で指定したファイルをスプライトデータとしてアップロードします。

スプライトデータにはsvgファイルを指定してください。

sprites delete

$ geolonia sprites delete [options]

スプライトデータを削除します。

generate-access-token

$ geolonia generate-access-token [options]

teams select コマンドで選択したチームにひもづくアクセストークンを発行します。発行されるトークンを環境変数GEOLONIA_ACCESS_TOKENの値に設定すると、credential.ymlなしでも各種コマンドを実行できます。

map-keys

マップキーに関してのコマンド。

map-keys list

$ geolonia map-keys list [options]

選択済みのチームにひもづくマップキーの一覧を表示します。

map-keys show

$ geolonia map-keys show [options] <keyId>

指定したマップキーの詳細を表示します。表示項目は Name, Key ID, User Key, Allowed Origins です。

keyIdには、map-keys list コマンドで表示される Key ID を使用してください。

map-keys search

$ geolonia map-keys search [options] <query>

マップキーを名前またはAllowed Originsで検索します。大文字小文字は区別しません。

map-keys new

$ geolonia map-keys new [options]

新しいマップキーを作成します。キー名の入力を求められます。

map-keys add-origin

$ geolonia map-keys add-origin [options] <keyId> <origin>

指定したマップキーにAllowed Originを追加します。

map-keys remove-origin

$ geolonia map-keys remove-origin [options] <keyId> <origin>

指定したマップキーからAllowed Originを削除します。

map-keys pull

$ geolonia map-keys pull [options]
$ geolonia map-keys pull -o keys.yml

現在のマップキー情報をYAML形式でエクスポートします。-oオプションでファイルに書き出せます。

map-keys plan

$ geolonia map-keys plan -f keys.yml

YAMLファイルの定義と現在の状態を比較し、差分を表示します。実際の変更は行いません。

map-keys apply

$ geolonia map-keys apply -f keys.yml

YAMLファイルの定義に基づいてマップキーを作成・更新します。定義にないキーは削除しません。

YAMLファイルの形式

keys:
  - name: production
    keyId: abc-123          # optional: 既存キーとの紐付け
    userKey: uk-xxxxx       # optional: 参照用（読み取り専用）
    origins:
      - https://example.com
      - https://app.example.com
  - name: staging
    origins:
      - https://staging.example.com

keyIdを指定した場合はそのキーを更新し、省略した場合はnameで既存キーを照合します。一致するキーがなければ新規作成します。