@jiangzhx/adcli 0.1.2 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +109 -37
  2. package/dist/cli.js +2438 -5
  3. package/docs/commands.md +79 -0
  4. package/package.json +16 -1
package/docs/commands.md CHANGED
@@ -115,6 +115,85 @@ adcli prompt
115
115
  adcli llms prompt
116
116
  ```
117
117
 
118
+ ### `adcli oceanengine auth`
119
+
120
+ 保存巨量引擎 access token。保存后，巨量引擎相关命令可以不再重复传 `--access-token`。
121
+
122
+ ```bash
123
+ adcli oceanengine auth <token>
124
+ ```
125
+
126
+ token 会按 CLI 缓存处理，保存到 AdCLI 缓存目录下的 `oceanengine.json`。macOS 默认路径：
127
+
128
+ ```text
129
+ ~/Library/Caches/adcli/oceanengine.json
130
+ ```
131
+
132
+ token 优先级：
133
+
134
+ 1. `--access-token`
135
+ 2. `OCEANENGINE_ACCESS_TOKEN`
136
+ 3. `adcli oceanengine auth <token>` 保存的本地 token
137
+
138
+ ### `adcli oceanengine advertiser list`
139
+
140
+ 通过当前仓库内的巨量引擎 Node.js SDK 拉取授权广告主列表。
141
+
142
+ ```bash
143
+ adcli oceanengine advertiser list --access-token <token>
144
+ adcli oceanengine advertiser list --json
145
+ ```
146
+
147
+ 也可以用环境变量提供 token，或先通过 `adcli oceanengine auth <token>` 保存 token：
148
+
149
+ ```bash
150
+ OCEANENGINE_ACCESS_TOKEN=<token> adcli oceanengine advertiser list --json
151
+ ```
152
+
153
+ 对应 SDK/API：
154
+
155
+ - SDK: `Oauth2AdvertiserGetApi`
156
+ - API: `GET /open_api/oauth2/advertiser/get/`
157
+
158
+ ### `adcli oceanengine project list`
159
+
160
+ 通过当前仓库内的巨量引擎 Node.js SDK 拉取广告主下的项目列表，对应巨量引擎 OpenAPI 的 `project/list`。
161
+
162
+ ```bash
163
+ adcli oceanengine project list --advertiser-id <advertiser_id> --access-token <token>
164
+ adcli oceanengine project list --advertiser-id <advertiser_id> --page 1 --page-size 20
165
+ adcli oceanengine project list --advertiser-id <advertiser_id> --json
166
+ adcli oceanengine project list --advertiser-id <advertiser_id> --filtering '{"status":"PROJECT_STATUS_ALL"}'
167
+ adcli oceanengine project list --advertiser-id <advertiser_id> --filtering '{"status_first":"PROJECT_STATUS_ENABLE"}'
168
+ ```
169
+
170
+ 默认输出只包含 `project_id` 和 `name` 两列；使用 `--json` 打印完整原始响应。
171
+ 巨量接口默认不返回已删除项目；需要和 fujian 同步口径一致时，使用 `--filtering '{"status":"PROJECT_STATUS_ALL"}'` 拉取包含已删除项目的全量列表。
172
+
173
+ 对应 SDK/API：
174
+
175
+ - SDK: `ProjectListV30Api`
176
+ - API: `GET /open_api/v3.0/project/list/`
177
+
178
+ ### `adcli oceanengine promotion list`
179
+
180
+ 通过当前仓库内的巨量引擎 Node.js SDK 拉取广告主下的广告列表，对应巨量引擎 OpenAPI 的 `promotion/list`。
181
+
182
+ ```bash
183
+ adcli oceanengine promotion list --advertiser-id <advertiser_id> --access-token <token>
184
+ adcli oceanengine promotion list --advertiser-id <advertiser_id> --project-id <project_id>
185
+ adcli oceanengine promotion list --advertiser-id <advertiser_id> --project-id <project_id> --json
186
+ adcli oceanengine promotion list --advertiser-id <advertiser_id> --fields promotion_id,name,status_first
187
+ adcli oceanengine promotion list --advertiser-id <advertiser_id> --filtering '{"status_first":"PROMOTION_STATUS_ENABLE"}'
188
+ ```
189
+
190
+ 默认输出只包含 `promotion_id` 和 `name` 两列；使用 `--json` 打印完整原始响应。
191
+
192
+ 对应 SDK/API：
193
+
194
+ - SDK: `PromotionListV30Api`
195
+ - API: `GET /open_api/v3.0/promotion/list/`
196
+
118
197
  ## 采集命令
119
198
 
120
199
  ### `bun run discover:sources`
package/package.json CHANGED
@@ -1,9 +1,12 @@
1
1
  {
2
2
  "name": "@jiangzhx/adcli",
3
- "version": "0.1.2",
3
+ "version": "0.1.3",
4
4
  "description": "CLI for searching hosted advertising platform API docs.",
5
5
  "type": "module",
6
6
  "packageManager": "bun@1.3.10",
7
+ "workspaces": [
8
+ "packages/*"
9
+ ],
7
10
  "homepage": "https://github.com/jiangzhx/adcli#readme",
8
11
  "repository": {
9
12
  "type": "git",
@@ -36,7 +39,18 @@
36
39
  "adcli": "bun src/cli.ts",
37
40
  "prepack": "bun run build:cli",
38
41
  "test": "bun test tests/**/*.test.ts",
42
+ "test:all": "bun run test && bun run sdk:test && bun run codegen:test",
39
43
  "typecheck": "tsc --noEmit",
44
+ "typecheck:all": "bun run typecheck && bun run sdk:typecheck && bun run codegen:typecheck",
45
+ "sdk:oceanengine:test": "bun run --cwd packages/oceanengine-ad-open-sdk test",
46
+ "sdk:oceanengine:typecheck": "bun run --cwd packages/oceanengine-ad-open-sdk typecheck",
47
+ "sdk:test": "bun run sdk:oceanengine:test",
48
+ "sdk:typecheck": "bun run sdk:oceanengine:typecheck",
49
+ "codegen:oceanengine:generate": "bun run --cwd packages/codegen generate:oceanengine",
50
+ "codegen:oceanengine:generate:go": "bun run --cwd packages/codegen generate:oceanengine:go",
51
+ "codegen:oceanengine:test": "bun run --cwd packages/codegen test:oceanengine",
52
+ "codegen:test": "bun run --cwd packages/codegen test",
53
+ "codegen:typecheck": "bun run --cwd packages/codegen typecheck",
40
54
  "lint": "eslint"
41
55
  },
42
56
  "devDependencies": {
@@ -49,6 +63,7 @@
49
63
  "typescript-eslint": "^8.59.3"
50
64
  },
51
65
  "dependencies": {
66
+ "@jiangzhx/oceanengine-ad-open-sdk": "1.1.87-port.3",
52
67
  "env-paths": "^4.0.0",
53
68
  "minisearch": "^7.2.0"
54
69
  }