beta
orc beta は、ログイン中のアカウントのベータ参加状態を確認し、招待コードを適用するコマンドです。status は参加の可否とアカウントのメールアドレスを返し、redeem は標準入力の招待コードを適用してから参加状態を読み直します。
先に orc auth login で本人のアカウントにログインしてください。アカウントを作成する場合は orc signup を使用します。CLIの認証情報はベータ参加やWorkspaceの準備が完了する前に保存されるため、参加を拒否された状態でもこのコマンドを実行できます。対象は本人のアカウントで、WorkspaceのAPIキーや委任されたAgentの資格情報では招待コードを適用できません。
使い方
orc beta statusログイン中のアカウントのベータ参加状態を確認します。
動作の流れ
- 保存された本人のCLI認証情報を使って、アカウントを確認します。ベータ参加権限は、この本人確認の前提にはなりません。
statusは現在の参加状態を取得します。redeemはJSONのcodeをサーバーへ送り、参加権限の付与を試みます。- 適用に成功した場合、
redeemは参加状態を取得し直します。成功応答の後でも、この読み戻しに失敗する場合はorc beta statusで現在の状態を確認してください。
参加状態の確認とコードの適用はアカウント単位です。Workspaceを切り替えても、別のアカウントに招待コードを適用する操作にはなりません。
サブコマンド
status
現在のアカウントの betaAccess と email を返します。betaAccess が true なら参加済み、false なら参加権限がありません。有効期限は応答に含まれません。参加前のアカウントでも確認できます。
orc beta status [options]使用例
orc beta status --json参加状態をJSONで確認します。
redeem
--stdin で読み込むJSONの code に招待コードを指定します。適用が成功すると status を読み直し、現在の参加状態を返します。すでに参加権限があるアカウントへの再送は、新たな招待コードの使用回数を消費しません。招待コードを引数へ直接指定する形式は使用できません。
orc beta redeem [options]使用例
orc beta redeem --stdin < beta-code.json入力ファイルの招待コードを本人のアカウントに適用します。
使用例
招待コードの入力
必須の code は空でない文字列です。--stdin はJSON本文を読み込み、必須項目が不足する場合は送信前にエラーを返します。
{
"code": "<invitation-code>"
}招待コードの入力
入力ファイルは本人だけが読める場所に保存してください。招待コードをシェル引数や履歴へ貼り付ける必要はありません。
招待コードを適用する
適用後に参加状態を読み直し、JSON envelopeで出力します。data.betaAccess と data.email から参加状態と対象アカウントを確認できます。
orc beta redeem --stdin < beta-code.json --json招待コードを適用する
送信内容を確認する
招待コードを伏せた送信予定のリクエストを表示します。リクエストを送らず、コードの使用回数や参加状態を変更しません。コードの有効性や参加枠はサーバーへの送信時に確認されます。
orc beta redeem --stdin < beta-code.json --dry-run送信内容を確認する
トラブルシューティング
認証できない場合
orc auth login で本人としてログインし直してください。APIキーを環境変数で指定している場合は、その指定を外して保存された本人の認証情報を使用します。ログイン済みでも betaAccess が false の場合は、招待コードの適用が必要です。
招待コードが受け付けられない場合
code_unavailable は利用できないコードを示します。失効、使用上限、別アカウントによる使用などの個別原因は応答で区別されません。入力を確認し、必要なら別のコードを入手してください。capacity_reached はベータ参加枠の上限、subject_not_found はアカウントを確認できない状態を示します。参加枠の上限の場合は時間をおいて参加案内を確認し、アカウントの問題ではログインし直してください。
state_conflict が返る場合は、コードの管理状態を確認する必要があります。同じ入力を繰り返す前に担当者へ確認してください。
適用後に処理が失敗した場合
Workspaceの準備に失敗すると、参加権限の付与後に workspace_bootstrap_failed が返る場合があります。最初に orc beta status で参加状態を確認してください。通信エラーや状態の読み戻しに失敗した場合も同様です。参加済みのアカウントへ再送しても、新たなコードの使用回数は増えません。
グローバルオプション
orc beta では、次のグローバルオプションを使用できます。
各オプションの詳細と使用例は、グローバルオプションを参照してください。
関連項目
orc signup: アカウントを作成してCLIを認可する。orc auth login: 既存アカウントでCLIへログインする。- グローバルオプション: JSON出力、標準入力、dry-runの共通仕様。