# CLI

Python API: `hubai_sdk.__main__`

提供 `hubai` 命令行界面。

CLI 公开与 [HubAIClient](/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/hubai_client.md)
相同的 HubAI 操作，无需编写 Python 代码。安装包即可使用 `hubai`；在开发过程中，运行 `python -m hubai_sdk` 效果相同。

## 身份验证

运行 `hubai login` 以打开 HubAI API 密钥页面并安全存储密钥。使用 `hubai login --relogin` 替换存储的密钥，使用 `hubai logout` 删除密钥。或者，在环境中设置 `HUBAI_API_KEY`。

## 命令组

 * `hubai model` 管理模型元数据：`ls`、`info`、`create`、`update` 和 `delete`。
 * `hubai variant` 管理模型变体：`ls`、`info`、`create` 和 `delete`。
 * `hubai instance` 管理模型工件：`ls`、`info`、`create`、`delete`、`config`、`files`、`upload` 和 `download`。
 * `hubai convert TARGET` 上传模型，运行托管转换，并下载输出。`TARGET` 是 `rvc2`、`rvc3`、`rvc4` 或 `hailo` 之一。

## 示例

```bash
hubai login
hubai model ls
hubai model info <model-id-or-slug>
hubai model create my-model --license-type MIT --tasks OBJECT_DETECTION
hubai variant ls
hubai instance ls
hubai convert rvc2 --path /path/to/model.onnx --name my-model
```

## 帮助和参数参考

使用 `hubai --help` 查看命令组，使用 `hubai <command> --help` 查看确切的 CLI 语法、选项和默认值。例如，使用 `hubai convert --help` 查看转换选项。

CLI
命令参数派生自公共服务函数。[hubai_sdk.services.models](/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/services/models.md)、[hubai_sdk.services.variants](https://docs.luxonis.com/zh/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/services/variants.md)、[hubai_sdk.services.instances](https://docs.luxonis.com/zh/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/services/instances.md)
和
[hubai_sdk.services.convert](/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/services/convert.md)
的生成 API 参考是相应资源和转换参数的详细参考。转换服务还记录了特定于目标的选项和校准行为。

## 函数

### convert_cli

```python
def convert_cli(*args: object, **kwargs: object) -> object:
```

通过共享 CLI 错误处理程序运行转换命令。

### login

```python
def login(relogin: Annotated[bool, Parameter(['--relogin', '-r'])] = False):
```

登录 HubAI。

参数

 * `relogin` (`Annotated[bool, Parameter(['--relogin', '-r'])]`): 如果已登录，则重新登录。

### logout

```python
def logout():
```

从 HubAI 注销。

### validate_api_key

```python
def validate_api_key(_: str) -> bool:
```

登录流程使用的占位符 API 密钥验证器。

## 属性

### app
