init
orc init は、資格情報を検証・保存し、Workspaceへの接続を確認するコマンドです。--website を指定するとサイトから観測設定を生成し、確定して初回batchの完了まで待ちます。
初回観測には既存のアカウントとWorkspaceへのアクセスが必要です。保存したブラウザーログインやAPIキーを使用し、アカウントやWorkspaceは作成しません。手順全体は CLI onboarding を参照してください。
使い方
printf '%s' "$ORCHESTOR_API_KEY" | orc init標準入力のAPIキーを検証して初期化します。
固有のオプション
--website
Website to onboard (waits through confirmation and the first batch)
型: string。任意。
orc init --website <value>--region
Observation region (API default: JP)
型: string。任意。
orc init --region <value>--language
Observation language (API default: ja)
型: string。任意。
orc init --language <value>--no-confirm
Stop after extraction to review and edit before confirmation
型: boolean。任意。
orc init --no-confirm--api-key
API key (deprecated; pipe via standard input instead)
型: string。任意。
orc init --api-key <value>使用例
サイトから初回観測まで実行します。
orc init --website https://example.com --workspace <workspace-id> --timeout 10mサイトから初回観測まで実行します。
設定生成後に編集のため停止します。
orc init --website https://example.com --workspace <workspace-id> --no-confirm設定生成後に編集のため停止します。
初回観測の設定と待機
--region と --language は観測する地域と言語です。省略時はAPIの既定値 JP と ja を使用します。対象は --workspace で指定できます。
--website は --wait を付けなくても待機します。--timeout に 10m などの制限を指定でき、既定の待機上限はありません。--poll-interval の既定値は 5s です。--json は構造化された結果を返します。
接続確認が設定保存後に失敗する場合、保存された設定は残ります。設定先と認証を確認して再試行してください。
処理を中断・タイムアウトした場合は、表示された設定生成やbatchの状態確認コマンドで現在の状態を確認してください。設定を編集してから確定する場合は --no-confirm を使用し、段階別の初回観測手順 に従って続けます。
グローバルオプション
orc init では、次のグローバルオプションを使用できます。
各オプションの詳細と使用例は、グローバルオプションを参照してください。