CLI

YouViCo CLI는 터미널에서 YouViCo를 빠르게 사용할 수 있는 도구입니다. 내부적으로 공식 JavaScript SDK를 사용하고, 명령 결과는 JSON으로 출력합니다.

설치

CLI는 Node.js 20 이상을 지원합니다.

npm install -g @youvico/cli

명령을 사용할 수 있는지 확인하세요.

youvico --help

인증

YouViCo 앱에서 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

프로젝트 댓글 목록:

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

프로젝트 댓글 작성:

youvico comment create \
  --project bdbff5de-96d7-468f-9db0-85fe28bd6b62 \
  --content "검토 준비가 끝났어요."

엔드포인트별 명령은 해당 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 헬퍼를 사용합니다. 멀티파트 업로드 시작, 각 파트 업로드, 업로드 완료까지 자동으로 처리합니다.

댓글 첨부파일

댓글 첨부파일 명령은 CLI 3.0.0 이상에서 사용할 수 있습니다.

--file과 --project 중 정확히 하나를 사용하고 필수 로컬 --path를 제공하세요.

파일 댓글용 첨부파일 업로드:

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

프로젝트 댓글용 첨부파일 업로드:

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

CLI는 대상에 맞는 SDK 헬퍼인 commentAttachments.uploadForFile 또는 commentAttachments.uploadForProject를 사용합니다. 전체 멀티파트 흐름을 처리하며, --name을 생략하면 로컬 파일 이름을 사용합니다.

댓글을 작성할 때 반환된 ID를 첨부하세요. --attachment는 반복해서 사용할 수 있으며, 첨부파일을 하나 이상 제공하면 --content를 생략할 수 있습니다.

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

첨부파일 삭제:

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

출력과 확인 프롬프트

조회 명령은 결과를 JSON으로 출력합니다. 삭제, 인증, 설정 명령은 짧은 확인 메시지를 출력합니다.

대부분의 삭제 명령은 실행 전에 확인을 요청합니다. 스크립트에서 확인 프롬프트를 건너뛰려면 --yes를 전달하세요.

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

Skill Registry 삭제 명령은 확인을 요청하지 않으며 --yes도 받지 않습니다.

도움말 보기

명령 그룹이나 개별 명령에 --help를 사용할 수 있습니다.

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 중 하나 이상을 제공하세요.
• 여러 파일을 첨부하려면 --attachment를 반복해서 사용하세요.
• --duration은 --anchor와 함께 사용해야 합니다. CLI에서는 양의 정수만 허용하지만 HTTP API와 SDK는 duration: 0도 허용합니다.

CLI 3.0.0에서 reaction 명령 그룹의 이름이 comment-reaction으로 변경됐습니다.