English
日本語
한국어

日本語

English
한국어

Appearance

ガイド

CLI ​

YouViCo CLIは、ターミナルからYouViCoをすばやく使うためのツールです。内部では公式JavaScript SDKを使用し、コマンド結果をJSONで出力します。

インストール ​

CLIはNode.js 20以上をサポートしています。

bash
npm install -g @youvico/cli

コマンドを使用できることを確認します。

bash
youvico --help

認証 ​

YouViCoアプリでAPIキーを作成し、ローカルに保存します。

bash
youvico auth api

保存されたAPIキーは 0600 権限で ~/.config/youvico/config.json に保存されます。キーがCLI出力に表示されることはありません。

環境変数でAPIキーを渡すこともできます。

bash
YOUVICO_API_KEY=YOUR_API_KEY youvico project search --query "launch"

保存済みのキーを確認または削除するには、次のコマンドを使います。

bash
youvico auth status
youvico auth clear

クライアントを設定する ​

config コマンドでクライアントオプションを確認または上書きできます。

bash
youvico config get
youvico config set --base-url https://api.youvico.com
youvico config set --timeout-ms 30000
youvico config clear --base-url
youvico config clear --timeout-ms
youvico config clear

代表的な例 ​

プロジェクト検索:

bash
youvico project search --query "launch"

ローカルファイルのアップロード:

bash
youvico file upload.file \
  --project bdbff5de-96d7-468f-9db0-85fe28bd6b62 \
  --path ./launch.mp4 \
  --name launch.mp4

ファイルのコメント一覧:

bash
youvico comment list --file FX1234567890ABCD

プロジェクトのコメント一覧:

bash
youvico comment list --project bdbff5de-96d7-468f-9db0-85fe28bd6b62

プロジェクトコメントを作成する:

bash
youvico comment create \
  --project bdbff5de-96d7-468f-9db0-85fe28bd6b62 \
  --content "レビューの準備ができました。"

エンドポイントごとのコマンドは、該当する APIリファレンス ページで例のタブを CLI に切り替えて確認してください。

ファイルをアップロードする ​

ローカルファイルのアップロードには youvico file upload.file を使用します。

bash
youvico file upload.file \
  --project bdbff5de-96d7-468f-9db0-85fe28bd6b62 \
  --path ./launch.mp4 \
  --name launch.mp4

CLIはSDKの files.upload ヘルパーを使用します。マルチパートアップロードの開始、各パートのアップロード、アップロード完了まで自動で処理します。

コメント添付ファイル ​

コメント添付ファイルコマンドはCLI 3.0.0以降で利用できます。

--file と --project のいずれか一方を使用し、必須のローカル --path を指定してください。

ファイルコメント用の添付ファイルをアップロードする:

bash
youvico comment-attachment upload \
  --file FX1234567890ABCD \
  --path ./review-note.pdf

プロジェクトコメント用の添付ファイルをアップロードする:

bash
youvico comment-attachment upload \
  --project bdbff5de-96d7-468f-9db0-85fe28bd6b62 \
  --path ./review-note.pdf

CLIは対象に応じてSDKの commentAttachments.uploadForFile または commentAttachments.uploadForProject ヘルパーを使用します。マルチパートアップロード全体を処理し、--name を省略するとローカルファイル名を使用します。

コメント作成時に返されたIDを添付します。--attachment は繰り返し指定でき、添付ファイルを1つ以上指定すれば --content を省略できます。

bash
youvico comment create \
  --project bdbff5de-96d7-468f-9db0-85fe28bd6b62 \
  --attachment CA1234567890ABCD

添付ファイルを削除する:

bash
youvico comment-attachment delete \
  --id CA1234567890ABCD \
  --yes

出力と確認プロンプト ​

取得コマンドは結果をJSONで出力します。削除・認証・設定コマンドは短い確認メッセージを出力します。

ほとんどの削除コマンドは実行前に確認を求めます。スクリプトで確認プロンプトを省略するには --yes を渡してください。

bash
youvico file delete \
  --id FX1234567890ABCD \
  --yes

Skill Registry の削除コマンドは確認を求めず、--yes も受け付けません。

ヘルプを見る ​

コマンドグループまたは個別コマンドに --help を使用できます。

bash
youvico file --help
youvico file upload.file --help
youvico comment-attachment --help
youvico comment-attachment upload --help
youvico comment-reaction --help

コマンドの動作 ​

マルチパートアップロードページの CLI タブには、記載されたエンドポイントだけを呼び出すコマンドではなく、フロー全体を処理する管理型ヘルパーコマンドが表示される場合があります。

コメントコマンドはファイルまたはプロジェクトのどちらかを対象にします。--file と --project のいずれか一方だけを使用してください。--anchor と --duration は --file と一緒に使う場合のみ有効です。

comment create には次の制約があります。

  • --content、--anchor、--attachment のいずれか1つ以上を指定してください。
  • 複数のファイルを添付するには --attachment を繰り返し指定してください。
  • --duration は --anchor と一緒に指定してください。CLIでは正の整数のみ指定できますが、HTTP APIとSDKは duration: 0 も受け付けます。

CLI 3.0.0で reaction コマンドグループの名前が comment-reaction に変更されました。