Metadata-Version: 2.4
Name: openboost-cli
Version: 1.0.0
Summary: Unified CLI and Python client for Openboost TikTok, Patent, and Amazon MCP servers.
Author: Openboost CLI
License: MIT
Keywords: mcp,cli,openboost,proboost,tiktok,patent,amazon
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Environment :: Console
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: httpx>=0.27
Requires-Dist: mcp>=1.24
Requires-Dist: rich>=13.0
Requires-Dist: typer>=0.12
Provides-Extra: dev
Requires-Dist: pytest>=8; extra == "dev"

# openboost-cli

统一 Openboost MCP 命令行工具，包含 TikTok、Patent、Amazon 三套 MCP 的交互式菜单、快捷命令、通用调用和 Python 客户端。

终端命令为 **`proboost`**（包名 `openboost-cli`）。

完整使用说明见 **[使用文档.md](使用文档.md)**。

## 安装

### 从源码开发安装

```bash
cd "/path/to/openboost-cli"
python3.12 -m venv .venv
source .venv/bin/activate
pip install --upgrade pip
pip install -e ".[dev]"
```

### 从离线安装包安装（wheel / 源码包）

仓库内每次执行 `python -m build` 后，安装包位于 **`dist/`**：

| 文件 | 说明 |
|------|------|
| `openboost_cli-<版本>-py3-none-any.whl` | 推荐：纯 Python，任意平台 Python 3.10+ 可用 |
| `openboost_cli-<版本>.tar.gz` | 源码分发包，`pip` 会本地构建后安装 |

在**任意**虚拟环境或全局环境中（需 Python ≥ 3.10，且能访问 PyPI 以下载依赖 `httpx`、`mcp`、`rich`、`typer`）：

```bash
pip install --upgrade pip
pip install "/path/to/openboost-cli/dist/openboost_cli-0.1.0-py3-none-any.whl"
```

若机器**完全离线**，需事先在同一 Python 版本下准备好依赖的 wheel，或使用带依赖缓存的 `pip download`，再 `pip install --no-index` 指向本地目录；此处与常规 Python 离线安装流程相同。

安装后命令为：

```bash
proboost --help
```

### 自行打包安装包

在 `openboost-cli` 项目根目录：

```bash
pip install build
python -m build
```

产物写入 **`dist/`**（`*.whl` 与 `*.tar.gz`），可将整个 `dist` 目录或单个文件拷贝给其他环境安装。

## 配置密钥

三套 MCP 共用同一个密钥时：

```bash
proboost config set --secret-key "你的密钥"
```

也可以只配置某一个 MCP：

```bash
proboost config set --mcp patent --secret-key "你的密钥"
proboost config set --mcp amazon --base-url "http://mcp.microdata-inc.com/mcp-servers/proboost-amazon-mcp"
```

环境变量也支持：

```bash
export OPENBOOST_SECRET_KEY="通用密钥"
export OPENBOOST_TIKTOK_SECRET_KEY="TikTok 专用密钥"
export OPENBOOST_PATENT_SECRET_KEY="Patent 专用密钥"
export OPENBOOST_AMAZON_SECRET_KEY="Amazon 专用密钥"
```

## 通用命令

```bash
proboost                 # 交互式菜单
proboost list            # 列出全部 55 个工具
proboost docs patent patent_query_search

proboost call tiktok tt_video_content \
  --set countryRegion=美国 \
  --set videoId=7587942790298979614

proboost call patent patent_query_count \
  --set query_text="TACD: virtual reality"

proboost call amazon amz_product_selection \
  --set webSiteId=1 \
  --set pages=1 \
  --set pagesSize=10
```

## 快捷命令示例

TikTok：

```bash
proboost tiktok commodity category-tree
proboost tiktok video content 7587942790298979614 --country 美国
proboost tiktok shop list --data-period last30d --country 美国
```

Patent：

```bash
proboost patent search count "TACD: virtual reality"
proboost patent search query "TACD: virtual reality" --limit 10
proboost patent detail bibliography --patent-number US11205304B2
proboost patent image-search single "https://example.com/image.jpg" --model 1 --patent-type D
```

Amazon：

```bash
proboost amazon product selection --site 1 --pages 1 --pages-size 10
proboost amazon product sku B0EXAMPLE --site 1
proboost amazon hot cat-tree --site 1 --rank-type "Best Seller"
```

复杂筛选条件可追加 `key=value`：

```bash
proboost amazon product selection --site 1 minPrice=10 maxPrice=30 sortField=sku_sales_last_30d sortOrder=desc
```

## Python 客户端

```python
from openboost_cli import Openboost

pb = Openboost()
content = pb.tiktok.tt_video_content(countryRegion="美国", videoId="7587942790298979614")
count = pb.patent.patent_query_count(query_text="TACD: virtual reality")
items = pb.amazon.amz_product_selection(webSiteId="1", pages=1, pagesSize=10)
```

## 测试

```bash
python -m pytest
proboost --help
proboost list
```
