> ## Documentation Index
> Fetch the complete documentation index at: https://avala.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI

> 터미널에서 Avala 리소스 관리하기

Avala CLI를 사용하면 데이터셋 목록, 내보내기 생성, 클라우드 스토리지 관리 등을 명령줄에서 직접 수행할 수 있습니다.

## 설치

<CodeGroup>
  ```bash Recommended theme={null}
  curl -fsSL https://avala.ai/install.sh | bash
  ```

  ```bash pip theme={null}
  pip install avala[cli]
  ```
</CodeGroup>

설치 스크립트는 Python 버전을 감지하고, pip을 통해 `avala[cli]`를 설치하며, 설정을 검증합니다. Python 3.9+ 이상이 필요합니다.

이렇게 하면 포맷된 터미널 출력을 위한 [Click](https://click.palletsprojects.com/) 및 [Rich](https://rich.readthedocs.io/)와 함께 `avala` 명령이 설치됩니다.

## 인증

환경 변수로 API 키를 설정하세요 (권장):

```bash theme={null}
export AVALA_API_KEY="avk_your_api_key"
```

또는 모든 명령에 플래그로 전달하세요:

```bash theme={null}
avala --api-key avk_your_api_key datasets list
```

인터렉티브하게 자격 증명을 설정하려면:

```bash theme={null}
avala configure
```

## 명령

### datasets

```bash theme={null}
# 모든 데이터셋 목록
avala datasets list

# 결과 제한
avala datasets list --limit 10

# 특정 데이터셋 가져오기
avala datasets get <uid>
```

### projects

```bash theme={null}
# 모든 프로젝트 목록
avala projects list

# 특정 프로젝트 가져오기
avala projects get <uid>
```

### exports

```bash theme={null}
# 모든 내보내기 목록
avala exports list

# 내보내기 세부정보 가져오기
avala exports get <uid>

# 새 내보내기 생성
avala exports create --project <uid>
avala exports create --dataset <uid>
```

### storage-configs

클라우드 스토리지 연결 관리 (AWS S3, Google Cloud Storage).

```bash theme={null}
# 스토리지 구성 목록
avala storage-configs list

# S3 버킷 추가
avala storage-configs create \
  --name "Production S3" \
  --provider aws_s3 \
  --s3-bucket-name my-bucket \
  --s3-bucket-region us-west-1 \
  --s3-access-key-id $AWS_ACCESS_KEY_ID \
  --s3-secret-access-key $AWS_SECRET_ACCESS_KEY

# 스토리지 연결 테스트
avala storage-configs test <uid>
```

### agents

자동화 에이전트를 관리합니다.

```bash theme={null}
# 에이전트 목록
avala agents list

# 에이전트 생성
avala agents create \
  --name "QA Bot" \
  --events "task.completed,result.submitted" \
  --callback-url https://example.com/hook
```

### webhooks

웹훅 구독을 관리합니다.

```bash theme={null}
# 웹훅 목록
avala webhooks list

# 웹훅 생성
avala webhooks create \
  --target-url https://example.com/webhook \
  --events "task.completed,export.ready"
```

## 환경 변수

| 변수               | 설명              | 기본값                           |
| ---------------- | --------------- | ----------------------------- |
| `AVALA_API_KEY`  | Avala API 키.    | 필수                            |
| `AVALA_BASE_URL` | API 기본 URL 재정의. | `https://api.avala.ai/api/v1` |

## 출력 형식

CLI는 포맷된 출력을 위해 [Rich](https://rich.readthedocs.io/)를 사용합니다:

* **목록 명령**은 포맷된 테이블로 결과를 표시합니다.
* **가져오기 명령**은 키-값 세부 뷰를 표시합니다.
* **생성/삭제 명령**은 확인 메시지를 출력합니다.

출력이 파이프되거나 리다이렉트될 때 색상과 포맷이 자동으로 비활성화됩니다.
