CLI 安装说明

知了标讯命令行工具,让您在终端中快速查询和分析招中标数据。

环境要求

  • Python 3.8 或更高版本
  • pip 包管理器
  • 已获取知了标讯 API Key(点击获取

步骤1:下载 CLI 工具

正在加载下载地址…

步骤2:安装依赖

使用 pip 安装所需的 Python 依赖包:

终端bash
pip install httpx pydantic-core pyyaml

步骤3:安装为全局命令

如果您在步骤1中通过浏览器下载了文件,需要手动赋予可执行权限并移动到系统命令目录:

终端bash
# 下载后赋予可执行权限
chmod +x ~/Downloads/zlbx.py

# 移动到全局命令目录(需要管理员权限)
sudo mv ~/Downloads/zlbx.py /usr/local/bin/zlbx

如果您在步骤1中使用了 curl 一键安装命令,此步骤可跳过。

步骤4:配置 API Key

CLI 工具需要 API Key 进行身份认证。支持两种配置方式:

方式一:通过命令行配置(推荐)

终端bash
zlbx config api-key "your-api-key-here"

API Key 将保存到 ~/.zlbx_env 文件中,文件权限为 600(仅用户可读写)。

方式二:通过环境变量设置

设置 ZLBX_API_KEY 环境变量,CLI 会优先读取环境变量中的 API Key。

步骤5:验证安装

运行以下命令验证 CLI 是否安装成功:

终端bash
# 查看版本
zlbx --version

# 列出所有可用命令
zlbx list

如果安装正确,您可以尝试一个实际查询来验证:

终端bash
# 测试查询
zlbx company-profile --company "华为"

环境变量

变量名说明
ZLBX_API_KEYAPI 密钥,优先于配置文件
ZLBX_API_BASEAPI 基础 URL(默认:https://mcp-server.zhiliaobiaoxun.com)

常见问题

如何处理中文参数?

使用单引号包裹中文参数,例如:zlbx company-profile --company '华为'

如何传递列表参数?

使用 JSON 数组格式,例如:--keywords '["服务器", "网络设备"]'

API Key 存储在哪里?

API Key 存储在 ~/.zlbx_env 文件中,文件权限为 600(仅用户可读写)。

查看使用说明查看 API 文档