Metadata-Version: 2.4
Name: zerone-cli
Version: 0.3.1
Summary: Zerone 私募股权数据 CLI 工具
Author-email: Zerone <tech@zerone.com.cn>
License: MIT
Project-URL: Homepage, https://ai.zerone.com.cn
Project-URL: Documentation, https://ai.zerone.com.cn
Keywords: cli,private-equity,finance,mcp,zerone
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Topic :: Office/Business :: Financial
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: typer>=0.9.0
Requires-Dist: httpx>=0.24.0
Requires-Dist: pydantic>=2.0.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: rich>=13.0.0
Requires-Dist: pandas>=2.0.0

# Zerone CLI

Zerone 私募股权数据命令行工具，通过 API Key 直接查询 Zerone 数据平台。

## 安装

```bash
pip install zerone-cli
```

## 快速开始

### 1. 配置 API Key

```bash
zerone config set-api-key YOUR_API_KEY
```

> 如何获取 API Key？请访问 [https://ai.zerone.com.cn](https://ai.zerone.com.cn) 注册账号后申请。

### 2. 查看帮助

```bash
zerone --help
```

### 3. 开始查询

#### 第一层：实体定位

```bash
# 实体模糊搜索
zerone entity-search "字节跳动"
```

#### 第二层：业务专题

```bash
# 查询实体综合画像
zerone entity-profile "中国石油"

# 查询实体财务数据列表
zerone entity-financial-list "中国石油" --page 1 --page-size 50

# 查询融资概率预测
zerone model-financing-probability "字节跳动" --type COMPANY

# 查询机构匹配推荐
zerone model-company-match-gp "字节跳动" --page 1 --page-size 5
```

#### 第三层：通用数据查询

```bash
# 查看有哪些表可以查
zerone get-available-tables

# 查看某张表的结构（字段名、类型、支持的操作符）
zerone get-table-schema company

# 单表查询（通过 JSON 文件传入参数）
zerone query --json-file query.json

# 聚合查询（通过 JSON 文件传入参数）
zerone aggregate --json-file aggregate.json
```

## 命令列表

| 命令 | 说明 | 层级 |
|------|------|------|
| `zerone config set-api-key` | 设置 API Key | — |
| `zerone config set-server-url` | 设置服务器地址（可选） | — |
| `zerone config show` | 查看当前配置 | — |
| `zerone entity-search` | 实体模糊搜索 | 第一层 |
| `zerone entity-profile` | 查询实体综合画像 | 第二层 |
| `zerone entity-financial-list` | 查询实体财务数据列表（分页） | 第二层 |
| `zerone model-financing-probability` | 查询融资概率预测模型 | 第二层 |
| `zerone model-company-match-gp` | 为项目公司匹配潜在投资机构 | 第二层 |
| `zerone get-available-tables` | 获取可查询表列表 | 第三层 |
| `zerone get-table-schema` | 获取指定表结构 | 第三层 |
| `zerone query` | 单表查询（筛选/排序/分页） | 第三层 |
| `zerone aggregate` | 聚合查询（GROUP BY + 聚合函数） | 第三层 |

## 通用查询 JSON 参数示例

### query.json（单表查询）

```json
{
  "table": "company",
  "select_columns": ["company_name", "found_date", "vertical"],
  "filters": [
    {"field": "vertical", "type": "like", "value": "人工智能"},
    {"field": "found_date", "type": "range", "value": ["2020-01-01", "2024-12-31"]}
  ],
  "order_by": ["found_date DESC"],
  "limit": 50
}
```

### aggregate.json（聚合查询）

```json
{
  "table": "company",
  "group_by": ["reg_province"],
  "metrics": [
    {"field": "company_id", "func": "count", "alias": "company_count"}
  ],
  "filters": [
    {"field": "vertical", "type": "like", "value": "人工智能"}
  ],
  "order_by": ["company_count DESC"],
  "limit": 50
}
```

### 使用方式

```bash
# 从文件读取参数
zerone query --json-file query.json
zerone aggregate --json-file aggregate.json

# 直接传入 JSON 字符串
zerone query --json '{"table":"company","select_columns":["company_name"],"limit":10}'
zerone aggregate --json '{"table":"company","group_by":["reg_province"],"metrics":[{"field":"company_id","func":"count","alias":"cnt"}]}'
```

## 常用参数说明

### 分页参数
- `--page`: 页码，从1开始，默认1
- `--page-size`: 每页条数，默认50，上限50

### 输出格式
- `--output`: 输出格式，可选 table/json/csv，默认 table

### 查询参数
- `--json-file`: JSON 参数文件路径（query/aggregate 专用）
- `--json`: JSON 参数字符串（query/aggregate 专用）

## 配置说明

配置文件保存在 `~/.zerone/config.yaml`，支持以下环境变量覆盖：

| 环境变量 | 说明 |
|----------|------|
| `ZERONE_API_KEY` | API Key |
| `ZERONE_SERVER_URL` | 服务器地址 |

## 系统要求

- Python 3.9+
- 有效的 Zerone API Key

## 许可证

MIT
