CLI

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

インストール

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

npm install -g @youvico/cli

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

youvico --help

認証

Settings -> API Keys でAPIキーを作成し、ローカルに保存します。

youvico auth api

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

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

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

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

youvico auth status
youvico auth clear

クライアントを設定する

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

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

代表的な例

プロジェクト検索:

youvico project search --query="launch"

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

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

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

youvico comment list --file=FX1234567890ABCD

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

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

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

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

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

出力と確認プロンプト

コマンド結果はJSONで出力されます。

削除コマンドはデフォルトで確認を求めます。スクリプトで確認プロンプトを省略するには --yes を渡してください。

youvico file delete --id FX1234567890ABCD --yes

ヘルプを見る

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

youvico file --help
youvico file upload.file --help

APIリファレンスページには、CLI、SDK、cURL の例タブが含まれています。マルチパートアップロードのエンドポイントでは、CLIからそのエンドポイントを直接呼び出さないため、CLI タブに file upload.file ヘルパーコマンドを表示します。