English
日本語
한국어

English

日本語
한국어

Appearance

Guide

CLI ​

The YouViCo CLI is the quickest way to use YouViCo from a terminal. It uses the official JavaScript SDK under the hood and prints command results as JSON.

Install ​

The CLI supports Node.js 20 and higher.

bash
npm install -g @youvico/cli

Check that the command is available:

bash
youvico --help

Authenticate ​

Create an API key in Settings -> API Keys, then save it locally:

bash
youvico auth api

Saved API keys are stored in ~/.config/youvico/config.json with 0600 permissions. The key is never printed in CLI output.

You can also provide an API key with an environment variable:

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

Check or clear the saved key:

bash
youvico auth status
youvico auth clear

Configure the client ​

Use config commands to inspect or override client options.

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

Common examples ​

Search projects:

bash
youvico project search --query="launch"

Upload a local file:

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

List comments on a file:

bash
youvico comment list --file=FX1234567890ABCD

For endpoint-specific commands, open the matching API reference page and switch the example tab to CLI.

Upload files ​

For local file uploads, use youvico file upload.file.

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

The CLI uses the SDK files.upload helper. It starts the multipart upload, uploads each part, and completes the upload automatically.

Output and confirmations ​

Command results are printed as JSON.

Delete commands ask for confirmation by default. Pass --yes to skip the prompt in scripts:

bash
youvico file delete --id FX1234567890ABCD --yes

Get help ​

Use --help on any command group or command:

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

API reference pages include CLI, SDK, and cURL example tabs. For multipart upload endpoints, the CLI tab shows the file upload.file helper because those endpoints are not called directly from the CLI.