メインコンテンツまでスキップ

Satcat CLI

Satcat CLIはSatcat SDKに含まれるコマンドラインアプリケーションで、Satcat上でよく行う操作をより早く、効率的に実行するためのツールです。

Satcat SDKのPythonライブラリが自動化システム向けのスクリプト作成に最適であるのに対し、Satcat CLIはPythonコードを書くことなく、コマンドラインから効率的にSatcatサービスを操作したい上級ユーザー向けに設計されています。

セットアップ方法

pipを使用してSatcat SDKをインストールした場合、Satcat CLIは自動的にパスに追加されているはずです。以下のコマンドでインストール状況を確認できます:

$ satcat version
satcat version 1.0.0

エンティティの一覧表示

satcatlistコマンドを使用すると、SatcatスクリーニングAPI内のあらゆるエンティティ(データ項目)を一覧表示できます。このリストには、自分が作成したスクリーニングジョブも含まれます。


$ satcat list screenings

┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┓
┃ Id ┃ Title ┃ Status ┃ Created At ┃ Conjunctions Count ┃ Primary Ids ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━┩
│ dd44f906-1e9c-40cd-b97f-e6d791b39b96 │ Screening │ SUCCESS │ 2022-06-22 14:50:24+00:00 │ 12[25544]
└──────────────────────────────────────┴───────────┴─────────┴───────────────────────────┴────────────────────┴─────────────────────┘
ヒント

リッチフォーマットのスクリーニング一覧テーブルでは、Idカラムの値が自動的に、Satcatウェブアプリケーションへのハイパーリンクに設定されます。(対応しているターミナルクライアントでは、ctrl-click / cmd-clickでWebブラウザから直接開くことができます。)

SatcatのスクリーニングはすべてSatcatサーバー上で実行されるので、SDKやCLIを使用して設定・実行したスクリーニングの結果をSatcatのウェブサイト上でも簡単に確認できます。


Satcat CLIの出力形式

デフォルトでは、Satcat CLIは人が読みやすいように、テーブル表示や進捗状況インジケーター含むリッチ形式の出力を使用します。一方で、機械処理やログ保存などを目的として、出力をプレーンなJSON形式に変更することも可能です。

出力形式をjsonに設定するには、satcatベースコマンドに--output-format(または-o)フラグを指定します:

    $ satcat --output-format json ...
備考

--output-formatフラグは、ベースのsatcatコマンドの後、かつサブコマンドの前に指定する必要があります。

       ❌ satcat list screenings --output-format json
✅ satcat --output-format json list screenings

ターミナル出力でのインタラクティブな進捗状況インジケーターを無効にするには、satcatベースコマンドに--no-progressフラグを指定します:

    $ satcat --no-progress ...

これらの設定は、settingsモジュールでsettings.output_formatおよびsettings.show_progressとして永続的に設定することもできます。

ヒント

デフォルトのリッチ形式出力は、最大限読みやすいように、各リソースタイプの情報のうち、厳選された一部のみが表示されます。リソースのすべてのフィールドを表示して詳細を確認したい場合は、--output-format jsonオプションを使用するのが最適です。