命令行 使用说明
前提条件
基本用法
显示客户端
隐藏客户端
解锁客户端
锁定客户端
返回结果
小贴士
命令行使用说明
为什么使用 CLI？
- 赋能您的独家定制体验，全面支持自行开发与深度集成，轻松打造高度个性化、符合特定业务需求的专属能力。
- 无需人工干预，可脚本化、自动化地控制客户端显示/隐藏、锁定/解锁，适配批处理、CI/CD、远程运维等场景。
- 标准化 JSON 返回结构，便于在各类语言与平台中统一处理结果、快速定位问题。
在软件安装目录下提供了命令行工具 Cli.exe，可用于快速控制客户端的显示、隐藏、解锁与锁定。
前提条件
- 需保证客户端版本 V6.3.6 及以上，且客户端已启动，否则命令将无法生效。
- 请在 软件安装目录 下运行 Cli.exe（或使用完整路径）。
- 如果路径中包含空格，请用引号包裹，例如："D:\\Program Files\\Weteoes\\TianXingPasswordBox\\Cli.exe"。
基本用法
在命令行中执行以下格式：
Windows CMD
Cli.exe --api=<操作> [--password=<密码>]显示客户端
Windows CMD
Cli.exe --api=showClient隐藏客户端
Windows CMD
Cli.exe --api=hideClient解锁客户端
Windows CMD
Cli.exe --api=unlockClient --password=${password}将 ${password} 替换为实际解锁密码。
锁定客户端
Windows CMD
Cli.exe --api=lockClient返回结果
所有操作均返回 JSON：
成功：
JSON
{"code":0}失败（示例）：
JSON
{"code":-2,"msg":"失败的原因"}小贴士
- 在脚本中调用时，建议对返回 JSON 进行解析并判断 code。
- 为安全起见，避免在可被他人读取的脚本中明文保存密码。