@yizhuan-cli/cli 0.1.3 → 0.1.5-beta.0

package/README.md

@@ -34,23 +34,47 @@ yizhuan config path
 yizhuan config show
 yizhuan execute --ability membership
 yizhuan execute --ability works --query "百家号昨天新增了哪些作品"
-yizhuan execute --ability accounts --params "{\"mode\":\"public_search\",\"platform\":\"toutiao\",\"keyword\":\"张三\"}"
-yizhuan execute --ability radar --params "{\"mode\":\"following\"}"
-yizhuan execute --ability radar --params "{\"mode\":\"timeline\",\"timeRange\":\"7d\"}"
-yizhuan execute --ability radar --params "{\"mode\":\"unfollow\",\"articleId\":\"205169870\"}"
+yizhuan execute --ability hot_topics --platform douyin
+yizhuan execute --ability hot_topics --params '{"platform":"douyin"}'
+yizhuan execute --ability accounts --params '{"mode":"public_search","platform":"toutiao","keyword":"张三"}'
+yizhuan execute --ability radar --params '{"mode":"following"}'
+yizhuan execute --ability radar --mode timeline --timeRange 7d
+yizhuan execute --ability radar --params '{"mode":"unfollow","articleId":"205169870"}'
+```
+
+### PowerShell 参数说明
+
+PowerShell 对 JSON 双引号转义不友好。推荐以下写法：
+
+```powershell
+# 最稳妥：独立参数
+yizhuan execute --ability hot_topics --platform douyin
+
+# 单引号包 JSON
+yizhuan execute --ability hot_topics --params '{"platform":"douyin"}'
+
+# key=value
+yizhuan execute --ability hot_topics --params platform=douyin
+```
+
+请避免 bash 风格的：
+
+```powershell
+# 在 PowerShell 中容易失败
+yizhuan execute --ability hot_topics --params "{\"platform\":\"douyin\"}"
 ```
 
 ## 支持的典型能力
 
 - 作品查询：`yizhuan execute --ability works --query "AI 相关的热门作品有哪些"`
 - 作者查询：`yizhuan execute --ability accounts --query "查询张三这个作者"`
-- 作者全网搜索：`yizhuan execute --ability accounts --params "{\"mode\":\"public_search\",\"platform\":\"toutiao\",\"keyword\":\"张三\"}"`
-- 关注全网作者：`yizhuan execute --ability accounts --params "{\"mode\":\"follow_public_author\",\"platform\":\"toutiao\",\"keyword\":\"张三\",\"extAuthorId\":\"author-1\"}"`
-- 热点查询：`yizhuan execute --ability hot_topics --query "查询头条平台热点话题"`
-- 雷达查询：`yizhuan execute --ability radar --params "{\"mode\":\"following\"}"`
-- 竞品动态：`yizhuan execute --ability radar --params "{\"mode\":\"timeline\",\"timeRange\":\"7d\"}"`
-- 竞品动态筛选：`yizhuan execute --ability radar --params "{\"mode\":\"timeline\",\"timeRange\":\"7d\",\"platform\":\"baijiahao\",\"keyword\":\"AI\"}"`
-- 取消关注雷达作者：先查询关注列表拿到 `articleId`，再执行 `yizhuan execute --ability radar --params "{\"mode\":\"unfollow\",\"articleId\":\"205169870\"}"`
+- 作者全网搜索：`yizhuan execute --ability accounts --params '{"mode":"public_search","platform":"toutiao","keyword":"张三"}'`
+- 关注全网作者：`yizhuan execute --ability accounts --params '{"mode":"follow_public_author","platform":"toutiao","keyword":"张三","extAuthorId":"author-1"}'`
+- 热点查询：`yizhuan execute --ability hot_topics --platform douyin`
+- 雷达查询：`yizhuan execute --ability radar --params '{"mode":"following"}'`
+- 竞品动态：`yizhuan execute --ability radar --mode timeline --timeRange 7d`
+- 竞品动态筛选：`yizhuan execute --ability radar --params '{"mode":"timeline","timeRange":"7d","platform":"baijiahao","keyword":"AI"}'`
+- 取消关注雷达作者：先查询关注列表拿到 `articleId`，再执行 `yizhuan execute --ability radar --params '{"mode":"unfollow","articleId":"205169870"}'`
 - 会员查询：`yizhuan execute --ability membership --query "我的会员什么时候到期"`
 
 如果你是通过 Codex、Cursor、Claude Code 这类 Agent 使用 CLI，也可以直接用自然语言提问，例如：

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yizhuan-cli/cli",
-  "version": "0.1.3",
+  "version": "0.1.5-beta.0",
   "description": "易撰命令行工具，用于通过 API Key 查询易撰真实数据。",
   "private": false,
   "type": "module",
@@ -14,7 +14,9 @@
   "scripts": {
     "start": "node src/index.js",
     "pack:dry-run": "npm pack --dry-run",
-    "smoke": "node src/index.js --help && node src/index.js --version"
+    "smoke": "node src/index.js --help && node --test src/version.test.js",
+    "test:params": "node --test src/params.test.js",
+    "test:version": "node --test src/version.test.js"
   },
   "engines": {
     "node": ">=22"

package/src/index.js

@@ -6,7 +6,7 @@ import { fileURLToPath } from 'node:url'
 
 const CLI_DIR = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..')
 const PACKAGE_PATH = path.join(CLI_DIR, 'package.json')
-const CONFIG_PATH = path.join(os.homedir(), '.config', 'yizhuan', 'config.json')
+const CONFIG_PATH = process.env.YIZHUAN_CONFIG_PATH || path.join(os.homedir(), '.config', 'yizhuan', 'config.json')
 const ABILITIES = new Set([
   'works',
   'accounts',
@@ -25,22 +25,49 @@ const ABILITIES = new Set([
   'favorites_query'
 ])
 
+const PARAM_FLAG_KEYS = [
+  'platform',
+  'mode',
+  'keyword',
+  'page',
+  'pageSize',
+  'timeRange',
+  'date',
+  'startDate',
+  'endDate',
+  'articleId',
+  'authorId',
+  'extAuthorId',
+  'collectionType',
+  'metric'
+]
+
 function printHelp() {
   console.log(`易撰 CLI
 
 Usage:
   yizhuan --help
   yizhuan --version
-  yizhuan execute --ability <ability> [--query <text>] [--params <json>]
+  yizhuan execute --ability <ability> [--query <text>] [--params <json>] [--platform <name>]
+  yizhuan query --json '<request JSON>' [--format json|table|markdown]
+  yizhuan query --json-file <path> [--format json|table|markdown]
   yizhuan config path
   yizhuan config show
 
 Examples:
   yizhuan execute --ability works --query "百家号昨天新增了哪些作品"
-  yizhuan execute --ability accounts --params "{\\"mode\\":\\"public_search\\",\\"platform\\":\\"toutiao\\",\\"keyword\\":\\"张三\\"}"
-  yizhuan execute --ability radar --params "{\\"mode\\":\\"following\\"}"
-  yizhuan execute --ability radar --params "{\\"mode\\":\\"timeline\\",\\"timeRange\\":\\"7d\\"}"
-  yizhuan execute --ability radar --params "{\\"mode\\":\\"unfollow\\",\\"articleId\\":\\"205169870\\"}"
+  yizhuan execute --ability hot_topics --platform douyin
+  yizhuan execute --ability hot_topics --params '{"platform":"douyin"}'
+  yizhuan execute --ability accounts --params '{"mode":"public_search","platform":"toutiao","keyword":"张三"}'
+  yizhuan execute --ability radar --params '{"mode":"following"}'
+  yizhuan execute --ability radar --mode timeline --timeRange 7d
+  yizhuan execute --ability radar --params '{"mode":"unfollow","articleId":"205169870"}'
+
+Notes:
+  - PowerShell 推荐优先使用 --platform / --mode 等独立参数，或单引号 JSON：--params '{"platform":"douyin"}'
+  - 所有 Shell 都可用 --json-file request.json，避免 JSON 引号被终端改写
+  - bash/zsh 也可用：--params '{"platform":"douyin"}' 或 --platform douyin
+  - 兼容 key=value：--params platform=douyin
 
 Abilities:
   works                 作品查询
@@ -53,6 +80,7 @@ Abilities:
 
 Config:
   ${CONFIG_PATH}
+  可通过环境变量 YIZHUAN_CONFIG_PATH 指定独立配置文件
 `)
 }
 
@@ -65,22 +93,84 @@ function readPackageVersion() {
   }
 }
 
-function parseArgs(argv) {
+function isBalancedJsonLike(text) {
+  let brace = 0
+  let bracket = 0
+  let quote = null
+  let escaped = false
+
+  for (const char of text) {
+    if (escaped) {
+      escaped = false
+      continue
+    }
+    if (char === '\\') {
+      escaped = true
+      continue
+    }
+    if (quote) {
+      if (char === quote) quote = null
+      continue
+    }
+    if (char === '"' || char === "'") {
+      quote = char
+      continue
+    }
+    if (char === '{') brace += 1
+    if (char === '}') brace -= 1
+    if (char === '[') bracket += 1
+    if (char === ']') bracket -= 1
+    if (brace < 0 || bracket < 0) return false
+  }
+
+  return brace === 0 && bracket === 0 && quote === null
+}
+
+function readFlagValue(argv, startIndex, key) {
+  let index = startIndex
+  let raw = argv[index]
+  if (raw == null) return { value: true, nextIndex: startIndex - 1 }
+
+  if (key === 'params' && /[{\[]/.test(raw)) {
+    let joined = raw
+    while (!isBalancedJsonLike(joined) && index + 1 < argv.length && !String(argv[index + 1]).startsWith('--')) {
+      index += 1
+      joined += argv[index]
+    }
+    return { value: joined, nextIndex: index }
+  }
+
+  return { value: raw, nextIndex: index }
+}
+
+export function parseArgs(argv) {
   const args = { _: [] }
   for (let index = 0; index < argv.length; index += 1) {
     const value = argv[index]
-    if (value.startsWith('--')) {
-      const key = value.slice(2)
-      const next = argv[index + 1]
-      if (!next || next.startsWith('--')) {
-        args[key] = true
-      } else {
-        args[key] = next
-        index += 1
-      }
-    } else {
+    if (!value.startsWith('--')) {
       args._.push(value)
+      continue
+    }
+
+    const body = value.slice(2)
+    const eqIndex = body.indexOf('=')
+    if (eqIndex > 0) {
+      const key = body.slice(0, eqIndex)
+      const raw = body.slice(eqIndex + 1)
+      args[key] = raw
+      continue
+    }
+
+    const key = body
+    const next = argv[index + 1]
+    if (!next || next.startsWith('--')) {
+      args[key] = true
+      continue
     }
+
+    const read = readFlagValue(argv, index + 1, key)
+    args[key] = read.value
+    index = read.nextIndex
   }
   return args
 }
@@ -101,13 +191,107 @@ function readConfig() {
   }
 }
 
-function parseParams(value) {
-  if (!value) return undefined
-  try {
-    return JSON.parse(value)
-  } catch {
-    throw new Error('--params 必须是 JSON，例如：--params "{\\"page\\":1}"')
+function stripWrappingQuotes(text) {
+  const value = String(text).trim()
+  if (
+    (value.startsWith('"') && value.endsWith('"')) ||
+    (value.startsWith("'") && value.endsWith("'"))
+  ) {
+    return value.slice(1, -1)
+  }
+  return value
+}
+
+function coerceScalar(value) {
+  const text = stripWrappingQuotes(value).trim()
+  if (text === 'true') return true
+  if (text === 'false') return false
+  if (text === 'null') return null
+  if (text !== '' && /^-?\d+(\.\d+)?$/.test(text)) return Number(text)
+  return text
+}
+
+function sanitizeJsonLike(text) {
+  return String(text)
+    .replace(/^\uFEFF/, '')
+    .replace(/[\u201C\u201D]/g, '"')
+    .replace(/[\u2018\u2019]/g, "'")
+    .replace(/\\+"/g, '"')
+    .replace(/\\+'/g, "'")
+    .replace(/\\([{}:[\]:,])/g, '$1')
+    .replace(/\\/g, '')
+    .replace(/\s+/g, ' ')
+    .trim()
+}
+
+function parseLooseObject(text) {
+  let body = String(text).trim()
+  if (!body) return undefined
+
+  if ((body.startsWith('{') && body.endsWith('}')) || (body.startsWith('[') && body.endsWith(']'))) {
+    body = body.slice(1, -1).trim()
   }
+  if (!body) return {}
+
+  const pairs = body
+    .split(',')
+    .map((part) => part.trim())
+    .filter(Boolean)
+  if (!pairs.length) return undefined
+
+  const result = {}
+  for (const pair of pairs) {
+    const matched = pair.match(
+      /^(?:["']?)([A-Za-z_][\w-]*)(?:["']?)\s*[:=]\s*(.+)$/
+    )
+    if (!matched) return undefined
+    result[matched[1]] = coerceScalar(matched[2])
+  }
+  return result
+}
+
+export function parseParams(value) {
+  if (value == null || value === true || value === false) return undefined
+  if (typeof value === 'object' && !Array.isArray(value)) return value
+
+  const original = String(value).trim()
+  if (!original) return undefined
+
+  const candidates = [original, sanitizeJsonLike(original), original.replace(/\\/g, '')]
+  for (const candidate of candidates) {
+    try {
+      const parsed = JSON.parse(candidate)
+      if (parsed && typeof parsed === 'object' && !Array.isArray(parsed)) return parsed
+    } catch {
+      // continue
+    }
+  }
+
+  for (const candidate of candidates) {
+    const loose = parseLooseObject(candidate)
+    if (loose) return loose
+  }
+
+  throw new Error(
+    '--params 必须是 JSON 或 key=value。PowerShell 推荐：--platform douyin 或 --params \'{"platform":"douyin"}\''
+  )
+}
+
+function assignFlagParams(params, args) {
+  for (const key of PARAM_FLAG_KEYS) {
+    if (args[key] == null || args[key] === true) continue
+    if (params[key] != null) continue
+    params[key] = coerceScalar(args[key])
+  }
+  return params
+}
+
+export function buildExecuteParams(args) {
+  const params = {
+    ...(parseParams(args.params) || {})
+  }
+  assignFlagParams(params, args)
+  return Object.keys(params).length > 0 ? params : undefined
 }
 
 async function execute(args) {
@@ -127,8 +311,8 @@ async function execute(args) {
     body: JSON.stringify({
       json: {
         ability,
-        query: args.query,
-        params: parseParams(args.params)
+        query: typeof args.query === 'string' ? args.query : undefined,
+        params: buildExecuteParams(args)
       }
     })
   })
@@ -142,6 +326,33 @@ async function execute(args) {
   console.log(JSON.stringify(payload.result?.data?.json ?? payload, null, 2))
 }
 
+function renderQuery(payload, format) {
+  if (format === 'json' || !format) return JSON.stringify(payload, null, 2)
+  if (payload.status === 'error') return `${payload.error.code}: ${payload.error.message}`
+  const items = payload.data?.items
+  if (!Array.isArray(items)) return JSON.stringify(payload, null, 2)
+  if (format === 'markdown') return items.map((item, index) => `| ${index + 1} | ${item.title || item.name || item.nickname || ''} |`).join('\n')
+  return items.map((item, index) => `${index + 1}\t${item.title || item.name || item.nickname || ''}`).join('\n')
+}
+
+async function query(args) {
+  const jsonText = args.jsonFile
+    ? fs.readFileSync(path.resolve(String(args.jsonFile)), 'utf8')
+    : args.json === '-'
+      ? fs.readFileSync(0, 'utf8')
+      : args.json || args.params
+  const request = parseParams(jsonText)
+  if (!request) throw new Error('query 必须提供 --json 请求对象')
+  const config = readConfig()
+  const response = await fetch(`${config.apiBaseUrl}/api/agent.query`, {
+    method: 'POST', headers: { authorization: config.apiKey, 'content-type': 'application/json', 'x-device-type': 'pc' },
+    body: JSON.stringify({ json: request })
+  })
+  const text = await response.text()
+  if (!response.ok) throw new Error(`请求失败 HTTP ${response.status}：${text}`)
+  console.log(renderQuery(JSON.parse(text).result?.data?.json ?? JSON.parse(text), args.format || 'json'))
+}
+
 async function main() {
   const args = parseArgs(process.argv.slice(2))
   const command = args._[0]
@@ -171,11 +382,27 @@ async function main() {
     await execute(args)
     return
   }
+  if (command === 'query') {
+    await query(args)
+    return
+  }
 
   throw new Error(`未知命令：${command}`)
 }
 
-main().catch((error) => {
-  console.error(error.message)
-  process.exit(1)
-})
+const isDirectRun = (() => {
+  const entry = process.argv[1]
+  if (!entry) return false
+  try {
+    return fs.realpathSync(path.resolve(entry)) === fs.realpathSync(fileURLToPath(import.meta.url))
+  } catch {
+    return false
+  }
+})()
+
+if (isDirectRun) {
+  main().catch((error) => {
+    console.error(error.message)
+    process.exit(1)
+  })
+}

package/src/params.test.js

@@ -0,0 +1,54 @@
+import test from 'node:test'
+import assert from 'node:assert/strict'
+import { buildExecuteParams, parseArgs, parseParams } from './index.js'
+
+test('parseParams accepts standard JSON', () => {
+  assert.deepEqual(parseParams('{"platform":"douyin"}'), { platform: 'douyin' })
+})
+
+test('parseParams repairs PowerShell-mangled escaped JSON fragments', () => {
+  assert.deepEqual(parseParams('{\\platform\\:\\douyin\\}'), { platform: 'douyin' })
+  assert.deepEqual(parseParams('{"platform":"douyin"}'.replaceAll('"', '\\"')), {
+    platform: 'douyin'
+  })
+})
+
+test('parseParams accepts key=value and loose objects', () => {
+  assert.deepEqual(parseParams('platform=douyin'), { platform: 'douyin' })
+  assert.deepEqual(parseParams('{platform:douyin,mode:list}'), {
+    platform: 'douyin',
+    mode: 'list'
+  })
+})
+
+test('buildExecuteParams merges top-level flags', () => {
+  assert.deepEqual(
+    buildExecuteParams({
+      params: '{"mode":"timeline"}',
+      platform: 'douyin',
+      timeRange: '7d'
+    }),
+    {
+      mode: 'timeline',
+      platform: 'douyin',
+      timeRange: '7d'
+    }
+  )
+})
+
+test('buildExecuteParams prefers explicit params keys over flags', () => {
+  assert.deepEqual(
+    buildExecuteParams({
+      params: 'platform=weibo',
+      platform: 'douyin'
+    }),
+    { platform: 'weibo' }
+  )
+})
+
+test('parseArgs preserves query JSON supplied after --json', () => {
+  assert.deepEqual(
+    parseArgs(['query', '--json', '{"intent":"author_search","platform":"douyin"}']),
+    { _: ['query'], json: '{"intent":"author_search","platform":"douyin"}' }
+  )
+})

package/src/version.test.js

@@ -0,0 +1,22 @@
+import assert from 'node:assert/strict'
+import { execFileSync } from 'node:child_process'
+import fs from 'node:fs'
+import path from 'node:path'
+import test from 'node:test'
+import { fileURLToPath } from 'node:url'
+
+const CLI_DIR = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..')
+const ENTRY_PATH = path.join(CLI_DIR, 'src', 'index.js')
+const PACKAGE_PATH = path.join(CLI_DIR, 'package.json')
+const expectedVersion = JSON.parse(fs.readFileSync(PACKAGE_PATH, 'utf8')).version
+
+for (const flag of ['--version', '-v']) {
+  test(`${flag} prints the package version`, () => {
+    const output = execFileSync(process.execPath, [ENTRY_PATH, flag], {
+      encoding: 'utf8'
+    }).trim()
+
+    assert.equal(output, expectedVersion)
+    assert.notEqual(output, '')
+  })
+}