Metadata-Version: 2.4
Name: jiff-geo-cli
Version: 0.1.3
Summary: Command line tools for GEO platform automation.
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: typer<0.16.0,>=0.15.0
Requires-Dist: click<8.2.0,>=8.1.0
Requires-Dist: httpx>=0.27.0
Requires-Dist: rich>=13.0.0
Requires-Dist: python-dotenv>=1.0.0
Provides-Extra: dev
Requires-Dist: build>=1.2.0; extra == "dev"
Requires-Dist: pytest>=8.0.0; extra == "dev"

# Geo CLI

Geo CLI 是面向 Agent 和自动化脚本的 GEO 平台命令行工具。

它提供品牌、服务类型、QueryJob、Query、评测任务、自动化监控、指标查询、数据分析、报告生成以及文章发布等能力。所有命令均使用明确的命令行参数，并以 JSON 格式输出结果，便于 Agent 稳定调用和解析。

通过 CLI 创建评测任务时，会同时在后台生成一份可离线打开的 HTML 分析报告。报告状态由 Python 内置 SQLite 自动管理，不需要安装或配置额外数据库。

## 安装

通过 PyPI 安装：

```powershell
python -m pip install jiff-geo-cli
```

升级到最新版本：

```powershell
python -m pip install --upgrade jiff-geo-cli
```

安装后可执行以下命令确认是否可用：

```powershell
geo --version
geo --help
```

## 配置环境变量

执行以下命令生成用户配置文件：

```powershell
geo config init
```

配置文件默认位置：

- Windows：`C:\Users\<用户名>\.geo-cli\.env`
- macOS / Linux：`~/.geo-cli/.env`

也可以在当前工作目录创建 `.env` 文件。当前目录中的配置会覆盖用户配置文件。

支持的环境变量：

| 环境变量 | 是否必填 | 默认值 | 用途 |
| --- | --- | --- | --- |
| `GEO_API_KEY` | 使用 GEO 平台接口时必填 | 无 | GEO 平台 API Key |
| `REPORT_AGENT_API_KEY` | 使用数据分析和报告生成时必填 | 无 | Report Agent API Key |
| `ARTICLE_API_KEY` | 使用文章发布功能时必填 | 无 | 发文服务 API Key |
| `ARTICLE_GROUP_ID` | 使用文章账号和发布功能时必填 | 无 | 发文账号分组 ID |
| `ARTICLE_GROUP_TEXT` | 否 | 无 | 发文账号分组展示文本 |

只需配置实际使用功能对应的 API Key。不要将包含真实密钥的 `.env` 文件提交到版本库。
