リファレンスCLI コマンド

アカウント

cdg auth login、logout、status の役割と前提条件、CLI で使うアカウントを別のアカウントに切り替える方法。

プライベートベータはまもなく開始します。CodeDAG はまだインストールできません。ウェイトリストに登録しておくと、招待を順次メールでお送りします。
GitHubで編集

cdg auth には 3 つのコマンドがあり、それぞれ CodeDAG へのログイン、ログアウト、現在のアカウントの確認に使います。どのディレクトリでも実行でき、プロジェクトの中にいる必要はありません。ログイン状態はコンピューターごとに保存され、同じコンピューター上のすべてのプロジェクトが 1 つのログインを共有します。--help を除くと、オプションがあるのは cdg auth status だけで、--local の 1 つです。ログインが必要な理由、ログインが必要なコマンド、ログイン状態の有効期間は、ログインとアカウントを参照してください。

cdg auth login

Terminal
cdg auth login

このコマンドは、ブラウザーで Google アカウントを使って CodeDAG にログインし、ログイン状態をこのコンピューターに保存します。ある Google アカウントで初めてログインすると、同時にそのアカウント用の CodeDAG アカウントが作成されるため、事前の登録は必要ありません。

このコマンドを実行するには、CodeDAG サービスに接続できる必要があります。接続できない場合はすぐに失敗し、ブラウザーは開きません。ログインは、コマンドを実行したコンピューターのブラウザーで完了させる必要があります。そのため、SSH のリモートセッション、コンテナー、GUI のないサーバーではログインできません。デスクトップのブラウザーがない場合を参照してください。ブラウザーを開いたあと、コマンドは最大 5 分間待ちます。その時間を過ぎてもログインが完了しない場合、コマンドは失敗して終了するので、もう一度実行してください。

すでにログインしている状態で実行すると、ログインの手続きをもう一度行います。成功すると、このコンピューターにあった元のログインが、新しいログインに置き換えられます。今回のログインが完了しなかった場合、元のログインはそのまま残ります。

普段は、このコマンドをわざわざ実行する必要はありません。cdg init、cdg dag submit、cdg auth status は、まだログインしていないことがわかると、先に同じログインの手続きへ案内し、そのあとで元のコマンドの処理を続けます。このコマンドを単独で実行する必要があるのは、主に、アカウントを切り替えるときと、このコンピューターがログインしていないために、キューで待っているワークフローが on-hold で止まったときです。

cdg auth logout

Terminal
cdg auth logout

このコマンドは、このコンピューターの CLI からログアウトし、このコンピューターに保存されているログイン状態を削除します。Web コンソールとほかのコンピューターでのログインには影響しません。ログアウトが、キューで待っているワークフローにどう影響するかは、ログアウトとアカウントの切り替えを参照してください。

ログアウトにネットワーク接続は必要ありません。CodeDAG サービスに接続できない場合、コマンドは警告を 1 件表示しますが、このコンピューターのログイン状態は削除されます。

cdg auth status

Terminal
cdg auth status [--local]

オプションなしで実行すると、このコマンドは、ログイン中のアカウント、サブスクリプションのステータス、現在の期間のクレジットの利用量を表示します。各項目の意味は、クレジットと利用状況を確認するを参照してください。

この使い方には、ログインと、CodeDAG サービスへの接続が必要です。まだログインしていない場合は、先に cdg auth login と同じログインの手続きへ案内し、そのあとでアカウント情報を表示します。

--local

cdg auth status --local は、このコンピューターに保存された認証情報だけをもとに、ログイン済みかどうかを判定します。ネットワークには接続せず、ブラウザーでのログインに進むこともありません。そのため、スクリプトやエージェントが、ログインの必要なコマンドを実行する前に使うのに向いています。終了コードは、ログイン済みなら 0、未ログインなら 1 です。表示されるのはユーザー ID だけで、メールアドレス、サブスクリプション、クレジットは表示されません。ログインがサーバー側ですでに無効になっている場合でも、ログイン済みと表示されます。

ログアウトとアカウントの切り替え

このコンピューターの CLI で別のアカウントを使うには、まずログアウトし、次に別の Google アカウントでログインして、最後に現在のアカウントを確認します。

Terminal
cdg auth logout
cdg auth login
cdg auth status

ブラウザーの Web コンソール(app.codedag.com)が元のアカウントでログインしたままになっていると、cdg auth login はそのアカウントをそのまま使います。この場合は、先に Web コンソールでログアウトしてから、ログインのコマンドを実行してください。複数のコンピューターで 1 つのアカウントを共有する方法と、ログアウトのルールの全体は、ログアウト、複数のコンピューター、アカウントの切り替えを参照してください。

ログアウトもアカウントの切り替えも、すでに実行が始まっているワークフローには影響しません。キューで待っているワークフローに実行の順番が来た時点で、このコンピューターの CLI は、そのワークフローを投入したアカウントでログインしている必要があります。そうでない場合、ワークフローは on-hold で止まり、後ろに並んだワークフローも一緒に待つことになります。ログインするか元のアカウントに切り替えてから、cdg dag recover <ワークフロー> を実行すれば続行できます。

関連ページ


最終更新