@jiangzhx/adcli 0.1.1 → 0.1.3

package/docs/commands.md

@@ -7,27 +7,43 @@
 
 ## 对外 CLI
 
-### `adcli doc search`
+### `adcli list`
 
-搜索已经发布到线上 docs pack 的广告平台文档。全局安装后直接使用：
+列出当前支持的广告平台和能力。
 
 ```bash
-adcli doc search "广告消耗"
+adcli list
+adcli list kuaishou
+adcli list --json
 ```
 
-项目内开发时也可以用：
+当前能力：
+
+- `doc`: 已发布的文档查询能力，对应命令形态是 `adcli doc search <query> --platform <platform>`。
+
+这个命令会读取本地缓存；缓存不存在时会下载线上 `search-index.json`。
+
+兼容命令：
 
 ```bash
-bun run adcli doc search "广告消耗"
+adcli doc list
+```
+
+### `adcli doc search`
+
+搜索已经发布到线上 docs pack 的广告平台文档。全局安装后直接使用：
+
+```bash
+adcli doc search "广告消耗"
 ```
 
 支持参数：
 
 ```bash
-bun run adcli doc search "广告消耗" --limit 5
-bun run adcli doc search "广告消耗" --json
-bun run adcli doc search "广告消耗" --index public/search-index.json
-bun run adcli doc search "广告消耗" --platform tencent_ads
+adcli doc search "广告消耗" --limit 5
+adcli doc search "广告消耗" --json
+adcli doc search "广告消耗" --index public/search-index.json
+adcli doc search "广告消耗" --platform tencent_ads
 ```
 
 全局 CLI 默认读取：
@@ -36,6 +52,19 @@ bun run adcli doc search "广告消耗" --platform tencent_ads
 https://adcli.jiangzhx.com/search-index.json
 ```
 
+第一次搜索会下载索引并写入系统标准缓存目录：
+
+- macOS: `~/Library/Caches/adcli/search-index.json`
+- Linux: `${XDG_CACHE_HOME:-~/.cache}/adcli/search-index.json`
+- Windows: `%LOCALAPPDATA%/adcli/Cache/search-index.json`
+
+主动更新缓存：
+
+```bash
+adcli doc sync
+adcli doc search "广告消耗" --refresh
+```
+
 也可以用环境变量覆盖：
 
 ```bash
@@ -54,6 +83,117 @@ ADCLI_SEARCH_INDEX=https://example.com/search-index.json adcli doc search "广
 
 查询词中包含平台别名时会提升对应平台的排序权重，例如 `广点通`、`腾讯广告` 会提升 `tencent_ads` 文档，但不会硬过滤其他平台。需要明确限制平台时，使用 `--platform tencent_ads`。
 
+### `adcli llms`
+
+输出给 AI / Agent 使用的 docs pack 入口。
+
+```bash
+adcli llms
+adcli llms --json
+```
+
+输出包括：
+
+- `llms.txt`
+- `llms-full.txt`
+- `search-index.json`
+- 各平台 index
+
+### `adcli prompt`
+
+输出一段可复制给 AI / Agent 的使用说明。
+
+```bash
+adcli prompt
+```
+
+这段 prompt 会要求 AI 优先使用 AdCLI 发布的 Markdown 文档，引用具体来源，并在文档不足时明确说明缺口。
+
+兼容命令：
+
+```bash
+adcli llms prompt
+```
+
+### `adcli oceanengine auth`
+
+保存巨量引擎 access token。保存后，巨量引擎相关命令可以不再重复传 `--access-token`。
+
+```bash
+adcli oceanengine auth <token>
+```
+
+token 会按 CLI 缓存处理，保存到 AdCLI 缓存目录下的 `oceanengine.json`。macOS 默认路径：
+
+```text
+~/Library/Caches/adcli/oceanengine.json
+```
+
+token 优先级：
+
+1. `--access-token`
+2. `OCEANENGINE_ACCESS_TOKEN`
+3. `adcli oceanengine auth <token>` 保存的本地 token
+
+### `adcli oceanengine advertiser list`
+
+通过当前仓库内的巨量引擎 Node.js SDK 拉取授权广告主列表。
+
+```bash
+adcli oceanengine advertiser list --access-token <token>
+adcli oceanengine advertiser list --json
+```
+
+也可以用环境变量提供 token，或先通过 `adcli oceanengine auth <token>` 保存 token：
+
+```bash
+OCEANENGINE_ACCESS_TOKEN=<token> adcli oceanengine advertiser list --json
+```
+
+对应 SDK/API：
+
+- SDK: `Oauth2AdvertiserGetApi`
+- API: `GET /open_api/oauth2/advertiser/get/`
+
+### `adcli oceanengine project list`
+
+通过当前仓库内的巨量引擎 Node.js SDK 拉取广告主下的项目列表，对应巨量引擎 OpenAPI 的 `project/list`。
+
+```bash
+adcli oceanengine project list --advertiser-id <advertiser_id> --access-token <token>
+adcli oceanengine project list --advertiser-id <advertiser_id> --page 1 --page-size 20
+adcli oceanengine project list --advertiser-id <advertiser_id> --json
+adcli oceanengine project list --advertiser-id <advertiser_id> --filtering '{"status":"PROJECT_STATUS_ALL"}'
+adcli oceanengine project list --advertiser-id <advertiser_id> --filtering '{"status_first":"PROJECT_STATUS_ENABLE"}'
+```
+
+默认输出只包含 `project_id` 和 `name` 两列；使用 `--json` 打印完整原始响应。
+巨量接口默认不返回已删除项目；需要和 fujian 同步口径一致时，使用 `--filtering '{"status":"PROJECT_STATUS_ALL"}'` 拉取包含已删除项目的全量列表。
+
+对应 SDK/API：
+
+- SDK: `ProjectListV30Api`
+- API: `GET /open_api/v3.0/project/list/`
+
+### `adcli oceanengine promotion list`
+
+通过当前仓库内的巨量引擎 Node.js SDK 拉取广告主下的广告列表，对应巨量引擎 OpenAPI 的 `promotion/list`。
+
+```bash
+adcli oceanengine promotion list --advertiser-id <advertiser_id> --access-token <token>
+adcli oceanengine promotion list --advertiser-id <advertiser_id> --project-id <project_id>
+adcli oceanengine promotion list --advertiser-id <advertiser_id> --project-id <project_id> --json
+adcli oceanengine promotion list --advertiser-id <advertiser_id> --fields promotion_id,name,status_first
+adcli oceanengine promotion list --advertiser-id <advertiser_id> --filtering '{"status_first":"PROMOTION_STATUS_ENABLE"}'
+```
+
+默认输出只包含 `promotion_id` 和 `name` 两列；使用 `--json` 打印完整原始响应。
+
+对应 SDK/API：
+
+- SDK: `PromotionListV30Api`
+- API: `GET /open_api/v3.0/promotion/list/`
+
 ## 采集命令
 
 ### `bun run discover:sources`
@@ -195,7 +335,7 @@ bun run lint
 
 ## 当前边界
 
-`adcli` CLI 当前只支持 `doc search`。采集、构建和校验还停留在 `bun run ...` 工程命令层。
+`adcli` CLI 当前支持 `doc search`、`doc sync` 和 `llms` 入口。采集、构建和校验还停留在 `bun run ...` 工程命令层。
 
 后续如果要把项目产品化成完整 CLI，可以逐步把这些能力收进 `adcli`：
 

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "@jiangzhx/adcli",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "CLI for searching hosted advertising platform API docs.",
   "type": "module",
   "packageManager": "bun@1.3.10",
+  "workspaces": [
+    "packages/*"
+  ],
   "homepage": "https://github.com/jiangzhx/adcli#readme",
   "repository": {
     "type": "git",
@@ -36,7 +39,18 @@
     "adcli": "bun src/cli.ts",
     "prepack": "bun run build:cli",
     "test": "bun test tests/**/*.test.ts",
+    "test:all": "bun run test && bun run sdk:test && bun run codegen:test",
     "typecheck": "tsc --noEmit",
+    "typecheck:all": "bun run typecheck && bun run sdk:typecheck && bun run codegen:typecheck",
+    "sdk:oceanengine:test": "bun run --cwd packages/oceanengine-ad-open-sdk test",
+    "sdk:oceanengine:typecheck": "bun run --cwd packages/oceanengine-ad-open-sdk typecheck",
+    "sdk:test": "bun run sdk:oceanengine:test",
+    "sdk:typecheck": "bun run sdk:oceanengine:typecheck",
+    "codegen:oceanengine:generate": "bun run --cwd packages/codegen generate:oceanengine",
+    "codegen:oceanengine:generate:go": "bun run --cwd packages/codegen generate:oceanengine:go",
+    "codegen:oceanengine:test": "bun run --cwd packages/codegen test:oceanengine",
+    "codegen:test": "bun run --cwd packages/codegen test",
+    "codegen:typecheck": "bun run --cwd packages/codegen typecheck",
     "lint": "eslint"
   },
   "devDependencies": {
@@ -49,6 +63,8 @@
     "typescript-eslint": "^8.59.3"
   },
   "dependencies": {
+    "@jiangzhx/oceanengine-ad-open-sdk": "1.1.87-port.3",
+    "env-paths": "^4.0.0",
     "minisearch": "^7.2.0"
   }
 }