OpenThread CLI 概览

在 GitHub 上查看源代码

OpenThread CLI 通过命令行界面提供配置和管理 API。使用 OT CLI 创建 OpenThread 开发环境，或将其用作包含额外应用代码的工具。例如，OpenThread 测试脚本使用 CLI 执行测试用例。

开始使用

使用 Docker 完成我们的模拟 Codelab，并查看 CLI 命令参考文档。

转到“模拟 Codelab” 转到 CLI 命令参考文档

使用 OT CLI

您可以将 OT CLI 与 OpenThread 边界路由器 (OTBR) 和 Thread 设备搭配使用。CLI 命令因设备类型和 build 标志而异。

非网络

如需将 OT CLI 与 OTBR 配合使用，请在每个命令前输入以下前缀：

sudo ot-ctl

线程设备

如需在 Thread 设备上使用 CLI 命令，请参阅平台文档、Codelab 或指南。对于许多示例，您可以开始输入不带前缀的命令：

state
router
Done

下面提供了一些资源，可帮助您轻松上手：

特殊字符

空格字符 (' ') 用于分隔命令名称和不同的参数，以及制表符 ('\t') 和换行符（'\r'、'\n'）。

某些参数可能包含空格，例如 Thread 网络名称。如需发送包含空格的参数，请使用反斜杠字符 ('\') 转义分隔符或反斜杠本身：

networkname Test\ Network
Done
networkname
Test Network
Done

参数映射

OT CLI 使用与 API 配置值相对应的预定义参数。这些映射可通过 CLI 命令传递，还可能会返回至 CLI 以访问各种网络数据命令，例如 netdata show。

otBorderRouterConfig

某些命令（例如 prefix add）需要 otBorderRouterConfig 值。如需通过命令行设置 otBorderRouterConfig 成员，OT CLI 会为每个成员解析映射的字母参数。例如，参数组合 paros 会连续设置 mPreferred、mSlaac、mDefaultRoute、mOnMesh 和 mStable 成员。

语法

在以下示例中，prefix 是必需的，otBorderRouterConfig 参数是可选的，分别映射到 p、a、d、c、r、o、s、n 和 D：

prefix add prefix [padcrosnD]

用法

若要使用参数映射，请勿在字母之间输入空格：

prefix add 2001:dead:beef:cafe::/64 paros

otRoutePreference

如需设置 otRoutePreference，请在 OT CLI 命令中使用 high、med 或 low。

语法

prefix add prefix [padcrosnD] [high|med|low]

用法

下面是使用映射的 otBorderRouterConfig 和 otRoutePreference 参数的示例：

prefix add 2001:dead:beef:cafe::/64 paros med
Done

otExternalRouteConfig

对于 otExternalRouteConfig 值，s 会映射到 mStable，n 会映射到 mNat64。

语法

publish route prefix [sn]

用法

route add 2001:dead:beef:cafe::/64 s
Done

返回值

大多数命令都会返回请求的值，后跟 Done：

br onlinkprefix
fd41:2650:a6f5:0::/64
Done

其他包含网络数据的命令可能会返回前缀、路由和服务记录的参数映射。如需了解详情，请参阅使用 OT CLI 显示和管理网络数据。