> For the complete documentation index, see [llms.txt](https://docs.roboflow.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.roboflow.com/reference/ko/platform/cli.md).

# CLI

Roboflow CLI 명령, 전역 플래그, JSON 출력, 리소스 축약형 및 편의 별칭에 대한 참조입니다.

Roboflow Python 패키지에는 CLI가 포함되어 있습니다 (`pip install roboflow`)로, 명령줄에서 Roboflow 플랫폼을 사용할 수 있습니다. 일관된 `roboflow <noun> <verb>` 패턴을 따르며, AI 코딩 에이전트 및 자동화 도구와 함께 사용할 수 있도록 구조화된 JSON 출력을 지원합니다.

## 명령

| 명령           | 설명                                  |
| ------------ | ----------------------------------- |
| `auth`       | 로그인, 로그아웃, 상태 확인, 기본 워크스페이스 설정      |
| `workspace`  | 워크스페이스 목록 조회 및 검사                   |
| `project`    | 프로젝트 목록 조회, 가져오기, 생성                |
| `version`    | 데이터셋 버전 목록 조회, 가져오기, 다운로드, 내보내기     |
| `image`      | 이미지 업로드, 가져오기, 검색, 태그 지정, 삭제, 주석 달기 |
| `model`      | 학습된 모델 목록 조회, 가져오기, 업로드             |
| `train`      | 모델 학습 시작                            |
| `infer`      | 이미지에 대해 추론 실행                       |
| `search`     | 워크스페이스 이미지 검색 및 결과 내보내기             |
| `deployment` | 전용 배포 관리                            |
| `workflow`   | 워크플로우 관리                            |
| `folder`     | 워크스페이스 폴더 관리                        |
| `annotation` | 주석 배치 및 작업                          |
| `autolabel`  | 기반 모델 또는 Roboflow 모델로 배치 자동 라벨링     |
| `universe`   | Roboflow Universe 검색                |
| `video`      | 비디오 추론                              |
| `batch`      | 배치 처리 작업 *(출시 예정)*                  |
| `completion` | 셸 자동 완성 스크립트 생성(bash, zsh, fish)    |

실행 `roboflow <command> --help` 를 실행하면 각 명령의 자세한 내용을 확인할 수 있습니다.

## 전역 플래그

이 플래그들은 모든 명령에서 작동하며 하위 명령 앞이나 뒤에 올 수 있습니다:

| 플래그           | 단축   | 설명                                |
| ------------- | ---- | --------------------------------- |
| `--json`      | `-j` | 구조화된 JSON으로 결과 출력(에이전트 및 파이프 처리용) |
| `--api-key`   | `-k` | API 키 재정의                         |
| `--workspace` | `-w` | 워크스페이스 재정의                        |
| `--quiet`     | `-q` | 진행 표시줄과 상태 메시지 숨기기                |
| `--version`   |      | 패키지 버전 표시                         |

## 에이전트를 위한 JSON 출력

모든 명령은 `--json` 프로그램적으로 파이프하고 파싱해도 안전한 구조화된 출력을 위해

```bash
roboflow --json project list | jq '.[0].id'
```

JSON 모드의 오류는 stdout은 비워 둔 채 stderr로 출력되어, 파이프로 연결해도 안전합니다:

```bash
roboflow --json project get nonexistent 2>error.json
# stdout는 비어 있고, stderr에는 다음이 포함됩니다: {"error": {"message": "...", "hint": "..."}}
```

종료 코드는 일관됩니다: 0 = 성공, 1 = 오류, 2 = 인증 오류, 3 = 찾을 수 없음.

## 자원 약식

자원은 간단한 식별자로 지정할 수 있습니다:

| 약식                   | 의미               |
| -------------------- | ---------------- |
| `my-project`         | 기본 워크스페이스를 사용합니다 |
| `my-ws/my-project`   | 명시적 워크스페이스       |
| `my-project/3`       | 기본 워크스페이스, 버전 3  |
| `my-ws/my-project/3` | 명시적 워크스페이스, 버전 3 |

버전 번호는 항상 숫자입니다. 이것이 바로 `x/y` 가 다음을 구분하는 방식입니다 `workspace/project` 및 `project/version`.

## 편의 별칭

일반적인 작업에는 짧은 최상위 별칭이 있습니다:

| 별칭                  | 동일한 명령                      |
| ------------------- | --------------------------- |
| `roboflow login`    | `roboflow auth login`       |
| `roboflow whoami`   | `roboflow auth status`      |
| `roboflow upload`   | `roboflow image upload`     |
| `roboflow download` | `roboflow version download` |
