CLI を使い始める

open

orc open は、CLIで選択しているWorkspaceのダッシュボードを既定ブラウザーで開きます。ターミナルで操作していたWorkspaceの情報や設定を、Webアプリで確認するときに使用します。

実行にはCLIの認証情報とWorkspaceの選択が必要です。現在のディレクトリを紐付ける場合は orc workspace link <workspace-id>、既定のWorkspaceを設定する場合は orc workspace use <workspace-id> を実行してください。CLIの認証情報はブラウザーへ渡されないため、Webアプリでもサインインが必要になる場合があります。

使い方

terminal
orc open

選択中のWorkspaceのダッシュボードを既定ブラウザーで開きます。

対象のWorkspaceは orc workspace current で確認できます。

動作の流れ

orc open は次の順に動作します。

  1. --workspace、ORCHESTOR_WORKSPACE_ID、現在のディレクトリの .orchestor/workspace.json、有効なプロファイルの既定Workspaceの順に対象を選択します。
  2. Workspace IDの形式とCLIの認証情報を確認します。
  3. ORCHESTOR_WEB_URL、プロファイルの webUrl、https://orchestor.io の順にWebアプリの接続先を選び、/w/<workspace-id> のURLを組み立てます。
  4. システムの既定ブラウザーを起動し、Workspace ID、選択元、URL、起動結果を出力します。

既定のURLは https://orchestor.io/w/<workspace-id> です。CLIはローカルの選択情報からURLを作成します。WebアプリでのサインインとWorkspaceへのアクセス確認は、ブラウザーで行われます。起動結果はブラウザー起動の受付を示し、ページの読み込み完了は確認しません。

使用例

紐付けたディレクトリから開く

Workspaceに紐付けたディレクトリで実行します。--workspace と ORCHESTOR_WORKSPACE_ID が設定されていなければ、ディレクトリの紐付けが使用されます。

terminal
orc open

紐付けたディレクトリから開く

既定ブラウザーで対象Workspaceのダッシュボードを開きます。

Workspaceを指定して開く

terminal
orc open --workspace <workspace-id>

Workspaceを指定して開く

ブラウザーを起動せずURLを確認する

terminal
orc open --dry-run --json

ブラウザーを起動せずURLを確認する

Workspaceと認証情報を確認し、対象URLをJSONで表示します。ブラウザーは起動しません。

トラブルシューティング

Workspaceが選択されていない

No Workspace selected. と表示された場合は、対象のディレクトリに移動し、Workspaceを紐付けてから開いてください。

terminal
orc workspace link <workspace-id>
orc open

現在のディレクトリにWorkspaceを紐付けて、ダッシュボードを開きます。

ディレクトリを問わず既定のWorkspaceを使う場合は、次のように設定します。

terminal
orc workspace use <workspace-id>
orc open

既定のWorkspaceを設定して、ダッシュボードを開きます。

意図したWorkspaceが開かない場合は、orc workspace current で選択元を確認してください。--workspace と ORCHESTOR_WORKSPACE_ID はディレクトリの紐付けや既定設定より優先されます。

認証情報がない

Not authenticated. と表示された場合は、orc auth login でサインインしてください。ブラウザーでサインイン画面が表示された場合は、Webアプリ側でもサインインしてください。

ブラウザーを起動できない

Could not start the default browser. と表示された場合は、エラーの案内にあるURLを手動で開くか、システムの既定ブラウザーを設定してください。

Workspace IDや接続先URLが無効

Workspace IDには英数字、_、- を使用してください。Webアプリの接続先は、認証情報を含まないHTTPまたはHTTPSのURLに設定します。ORCHESTOR_WEB_URL と有効なプロファイルの webUrl を確認してください。

グローバルオプション

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

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

関連項目