跳到主要内容

十三、CLI命令行工具

十三、CLI命令行工具​

OpenQuant提供了强大的命令行工具，支持多种系统管理和信息查询功能。

13.1 基本使用​

CLI工具通过以下方式调用：

# 基本语法
./open_quant cli <command> [options]

# 查看帮助
./open_quant cli --help

13.2 可用命令​

📡 查看IP映射关系​

命令: ./open_quant cli ips

功能: 显示网卡IP到公网IP的映射关系，用于API绑定配置

输出示例:

🔍 查询IP信息...

📡 IP映射关系:
   ┌─────────────────────────────────────────────────────────┐
   │ 网卡IP → 公网IP (API应绑定公网IP)                        │
   ├─────────────────────────────────────────────────────────┤
   │ 192.168.1.100     → 203.0.113.1                        │
   │ 10.0.0.50         → 198.51.100.2                       │
   └─────────────────────────────────────────────────────────┘

💡 提示: API绑定IP时请使用右侧的公网IP地址

🔍 查询依赖Git Hash​

命令: ./open_quant cli dep-hash <dependency_name>

功能: 查询指定依赖的Git Hash信息

参数:

  • dependency_name: 依赖包名称（如：quant_common, algo_common等）

输出示例:

🔍 查询依赖 quant_common 的Git Hash信息...

📦 依赖信息:
   ┌─────────────────────────────────────────────────────────┐
   │ 📋 名称: quant_common                                │
   │ 🔗 Git Hash: 4a7fb325bf23424747713fb96cf807d97982cdf3 │
   │ 📝 来源: Git依赖                                    │
   └─────────────────────────────────────────────────────────┘

📊 查询系统状态​

命令: ./open_quant cli status

功能: 显示系统状态、OpenQuant状态和性能指标

输出示例:

🔍 查询系统状态...

📊 系统状态信息:
   ┌─────────────────────────────────────────────────────────┐
   │ 🖥️  操作系统: Ubuntu 20.04.3 LTS                    │
   │ 🧠 CPU核心数: 8                                      │
   │ 🧠 CPU使用率: 25%                                    │
   │ 💾 内存总量: 16GB                                    │
   │ 💾 内存使用率: 45%                                   │
   │ 💽 磁盘总量: 500GB                                   │
   │ 💽 磁盘使用率: 30%                                   │
   │ 🌐 网络上行: 1024 Kb/s                               │
   │ 🌐 网络下行: 2048 Kb/s                               │
   └─────────────────────────────────────────────────────────┘

📦 OpenQuant状态:
   ┌─────────────────────────────────────────────────────────┐
   │ 🚀 运行状态: 运行中                                    │
   │ 🔗 网络连接: 正常                                      │
   │ 🎯 目标平台: x86_64-unknown-linux-gnu                 │
   │ ⚡ 响应时间: 15ms                                      │
   │ 🔄 连接数: 45                                         │
   │ 💾 内存占用: 128MB                                    │
   └─────────────────────────────────────────────────────────┘

📋 版本信息查询​

命令: ./open_quant cli --version 或 ./open_quant cli -V

功能: 显示详细的版本信息

输出示例:

🚀 OpenQuant 0.9.0-alpha.18
📦 Git Hash: 2cae538
⏰ Build Time: 2025-07-30 05:53:46
🎯 Target: x86_64-unknown-linux-gnu
🏗️  Target Arch: x86_64
💻 Target OS: linux
🏢 Target Vendor: unknown
🔧 Build Type: true

13.3 技术特性​

  • 现代化CLI框架: 使用clap derive宏实现，提供完整的帮助信息和错误处理
  • 美观输出格式: 采用表格化显示，信息清晰易读
  • 动态依赖解析: 自动解析Cargo.lock中的Git依赖信息
  • 实时系统监控: 获取真实的系统资源使用情况和网络状态
  • 构建信息集成: 集成Git Hash、构建时间等详细信息

13.4 使用场景​

  1. 部署配置: 使用ips命令查看公网IP，配置API绑定
  2. 版本管理: 使用dep-hash命令查询依赖版本，确保环境一致性
  3. 系统监控: 使用status命令监控系统资源使用情况
  4. 问题诊断: 使用版本信息进行问题排查和环境验证