CLI を使い始める

signup

orc signup は、ブラウザーで新しいOrchestorアカウントを作成し、CLIにログインするコマンドです。登録とメール確認を済ませてCLIを認可すると、認証情報を保存し、読み戻しを確認して完了します。パスワードやメールの確認コードをターミナルへ入力する必要はありません。

すでにアカウントがある場合は、orc auth login を使用してください。ブラウザーを操作できる環境で実行します。CLIへのログイン、ベータ参加、ワークスペースの初回設定は別の状態です。ベータ未参加でも認証情報は保存され、ログイン後に orc beta status で参加状態を確認し、招待コードがあれば orc beta redeem --stdin < beta-code.json で適用できます。

使い方

terminal
orc signup

新しいアカウントを作成し、CLIにログインします。

ワークスペースの準備が完了した場合は、orc whoami でログイン中のアカウントを確認できます。初回設定が必要と表示された場合は、出力された次の操作を実行してください。

動作の流れ

  1. CLIが認可リクエストを開始し、登録画面をブラウザーで開きます。通常の出力には、手動で開けるURLとCLI認可の確認コードが表示されます。
  2. ブラウザーでアカウントを登録し、メール確認を完了します。メール確認コードはブラウザーに入力します。
  3. 登録画面からCLI認可画面へ戻ります。ターミナルと画面の確認コードが一致することを確認し、表示されたアカウントでCLIを認可します。
  4. CLIが認証情報を受け取り、ワークスペースへのアクセス状態を確認して、認証情報を保存・再読します。ベータ未参加や初回設定待ちの場合もログインは完了し、その状態と次の操作を表示します。

--json、--pretty、--ndjson、または --format json|pretty|ndjson を指定すると、標準出力は構造化された結果になります。通常の進捗や確認コードは表示されません。ブラウザーを自動で開けない環境では、これらの出力指定を外して実行してください。

固有のオプション

--ndjson

Output the authorization result as one JSON line

型: boolean。任意。

terminal
orc signup --ndjson

使用例

認証と初回設定の状態をJSONで確認します。

terminal
orc signup --json

認証と初回設定の状態をJSONで確認します。

ブラウザーでの登録と認可は引き続き必要です。認証情報そのものは出力しません。認証完了時は data.authenticated が true となり、data.workspace_ready、data.onboarding_needed、data.first_read_succeeded、data.next でワークスペースの準備状態と次の操作を確認できます。初回設定が必要な場合でも、保存した認証情報をベータ操作に使用できます。

ブラウザーやAPIを操作せずに処理内容を確認します。

terminal
orc signup --dry-run

ブラウザーやAPIを操作せずに処理内容を確認します。

処理の概要を標準エラーへ出力します。登録、認可リクエスト、認証情報の保存は行いません。

トラブルシューティング

登録や認可を中断した場合

Ctrl+C で中止できます。登録を完了していない場合は orc signup を再実行してください。アカウントの登録が済んでいる場合は orc auth login で認可をやり直します。認可が拒否された場合や期限切れの場合は、その認可リクエストでログインは完了しません。表示されたログインの再試行案内に従ってください。

メール確認後にログイン画面へ戻った場合

メール確認が成功しても自動ログインに失敗した場合は、ブラウザーのログイン画面で続行してください。CLI認可画面への戻り先は維持されます。

ベータ未参加と表示された場合

認証情報は保存されています。orc beta status で状態を確認し、招待コードがあれば orc beta redeem --stdin < beta-code.json を実行してください。ベータ参加が必要なワークスペース操作は、参加前には引き続き拒否されます。

ワークスペースの初回設定が必要な場合

ブラウザーの /welcome で初回設定を完了してください。出力の next に orc open /welcome が表示された場合は、そのコマンドで開けます。ログイン完了だけではワークスペースの準備完了を意味しません。

認証情報を保存・確認できない場合

保存や読み戻しに失敗した場合は、正常完了として扱わず、表示されたエラーを確認してください。ブラウザー認可の拒否や不正な認証応答では、新しい認証情報は保存されません。

グローバルオプション

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

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

関連項目

  • orc auth login:既存アカウントでCLIにログインする。
  • orc whoami:利用可能なアカウントとワークスペースを確認する。
  • orc beta:ベータの参加状態と招待コードを管理する。
  • グローバルオプション:対応する出力形式やヘルプを確認する。