# cli

Python API: `luxonis_ml.telemetry.cli`

用于遥测的 CLI 仪表适配器。

此包封装了命令行应用程序的命令。如果遥测保持启用状态，每个已检测的命令在每次运行时都会发出一个 `cli_command` 事件。对于 Typer 应用程序，请使用
[instrument_typer](/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/telemetry/cli/typer.md)；对于
Cyclopts 应用程序，请使用
[instrument_cyclopts](/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/telemetry/cli/cyclopts.md)。两者都会递归遍历应用程序，因此它们涵盖了每个子应用程序的命令。Cyclopts
适配器会跳过生成的帮助和版本回调。`exclude_commands` 和
[skip_telemetry](/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/telemetry/cli/shared.md)
会使更多命令未被检测。

默认情况下，已检测的命令会报告其名称、成功标志及其持续时间（以毫秒为单位）。`include_system_metadata` 会添加系统字段，但仅当客户端持有系统上下文提供程序时。首先将
`system_context_providers=[system_context_provider]` 传递给
[Telemetry](/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/telemetry/client.md)。参数值保持本地，除非调用者在
`allowlist` 中命名它们。

> **示例**
> 检测 Typer 应用程序并使每个参数值保持本地。

```python
import typer
from luxonis_ml.telemetry import Telemetry
from luxonis_ml.telemetry.cli import instrument_typer

app = typer.Typer()
telemetry = Telemetry("luxonis_ml")

instrument_typer(app, telemetry)
```

> **注意**
> 此包在首次使用时导入每个适配器模块，因此 Typer 应用程序从不加载 Cyclopts 适配器。Cyclopts 是 LuxonisML 的基本依赖项。Typer 不是，因此在调用 [instrument_typer](/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/telemetry/cli/typer.md) 之前自行安装。

> **另请参阅**
> [skip_telemetry](/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/telemetry/cli/shared.md) 以排除一个命令回调。

## 子页面

 * [cyclopts](/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/telemetry/cli/cyclopts.md)
 * [shared](/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/telemetry/cli/shared.md)
 * [typer](/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/telemetry/cli/typer.md)

## 函数

### getattr

```python
def __getattr__(name: str) -> Any:
```

延迟导入可选的 CLI 适配器，以便它们的依赖项保持可选。
