基本操作

config

orc config は、CLIの認証元と設定ファイルの場所を確認し、保存した設定値を取得・変更するコマンドです。読み取りでAPIキーの秘密値は表示せず、設定した資格情報は秘密値を含まない識別子や設定済み状態で確認できます。

対象は現在のローカルCLI設定です。アカウントのプロフィールやサーバーのWorkspace設定は変更しません。資格情報の設定には orc auth login を使用してください。

使い方

terminal
orc config show

現在の認証元と設定ファイルを確認します。

サブコマンド

show

認証設定の有無、認証元、設定ファイルのパス、設定の不足を表示します。資格情報がある場合は秘密値ではなくopaque IDを表示します。

terminal
orc config show [options]

get

key に apiKey、apiKeyHelper、apiUrl、defaultWorkspace、profile を指定して保存値を取得します。apiKey が設定されている場合は [redacted] を返します。未設定の値は空文字で、未対応のキーは終了コード2です。

terminal
orc config get <key> [options]

set

対応する key と空でない value を指定して保存します。値の前後の空白は除きます。apiKeyHelper にはコマンドの引数配列をJSONで指定します。保存先のパスを表示し、APIキーの値は表示しません。

terminal
orc config set <key> <value> [options]

使用例

既定Workspaceを取得します。

terminal
orc config get defaultWorkspace

既定Workspaceを取得します。

既定Workspaceを変更します。

terminal
orc config set defaultWorkspace <workspace-id>

既定Workspaceを変更します。

Secret ManagerからAPIキーを読むコマンドを設定します。

terminal
orc config set apiKeyHelper '["gcloud","secrets","versions","access","latest","--secret=orc-dev-<user>"]'

Secret ManagerからAPIキーを読むコマンドを設定します。

ローカルのAPIへ明示的に接続します。

terminal
orc --api-url http://localhost:40900 whoami

ローカルのAPIへ明示的に接続します。

設定と検証

ローカルの保存値を変更しても、資格情報の有効性やWorkspaceへのアクセス権を検証したことにはなりません。変更後に orc status または orc auth status で確認してください。秘密値を config set の引数としてシェル履歴へ渡す代わりに、auth login の標準入力を使用します。

APIの接続先と明示的なAPIキー

APIの接続先は、グローバルオプション --api-url <url>、環境変数 ORCHESTOR_API_URL、プロファイルの apiUrl、既定値 https://api.orchestor.io の順に決まります。

orc auth login で保存したサインインは、発行元のAPIとauthのoriginに結び付きます。接続先のoriginが異なる場合、保存したサインインは送信も更新もせず、終了コード2で終了します。別の接続先にはAPIキーを明示してください。

資格情報は ORCHESTOR_API_KEY、プロファイルの apiKeyHelper、保存したAPIキー、保存したサインインの順に使います。apiKeyHelper はシェルを介さずに実行するコマンドの引数配列で、標準出力の前後の空白を除いた値をAPIキーとして使います。キーはメモリーにだけ5分間保持し、401を受けたときは再実行します。ディスクには書き込まず、出力にも表示しません。

グローバルオプション

orc config では、次のグローバルオプションを使用できます。

各オプションの詳細と使用例は、グローバルオプションを参照してください。