CLI を使い始める

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

terminal
orc config get <key> [options]

set

対応する key と空でない value を指定して保存します。値の前後の空白は除きます。保存先のパスを表示し、APIキーの値は表示しません。

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

使用例

既定Workspaceを取得します。

terminal
orc config get defaultWorkspace

既定Workspaceを取得します。

既定Workspaceを変更します。

terminal
orc config set defaultWorkspace <workspace-id>

既定Workspaceを変更します。

設定と検証

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

グローバルオプション

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

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