yuanflow-cli 0.1.0 → 0.1.1

package/src/shortcuts.js

@@ -0,0 +1,346 @@
+export const shortcuts = [
+  {
+    platform: 'douyin',
+    command: 'video-detail',
+    description: '抖音作品详情，适合用分享链接或作品链接查询作品基础数据。',
+    method: 'POST',
+    socialPath: '/douyin/app/v3/fetch_multi_video_v2',
+    positionals: [{ name: 'url', label: '作品链接' }],
+    options: [],
+    returns: '返回作品基础信息、作者信息、互动统计、媒体信息等字段，字段结构以上游实际响应为准。',
+    alternatives: [
+      'GET /social/douyin/app/v3/fetch_one_video_by_share_url?share_url=...',
+      'GET /social/douyin/web/fetch_one_video?aweme_id=...',
+    ],
+  },
+  {
+    platform: 'douyin',
+    command: 'video-download',
+    description: '抖音视频播放/下载地址查询，常用于获取最高画质播放链接。',
+    method: 'GET',
+    socialPath: '/douyin/app/v3/fetch_video_high_quality_play_url',
+    positionals: [{ name: 'share_url', label: '作品链接或分享链接' }],
+    options: [{ flag: 'region', name: 'region', label: '地区，可选，如 CN' }],
+    returns: '返回视频播放地址、清晰度信息、媒体地址等；是否可直接下载取决于上游返回和目标平台限制。',
+    alternatives: [
+      'POST /social/douyin/app/v3/fetch_multi_video_high_quality_play_url',
+      'GET /social/douyin/web/fetch_video_high_quality_play_url',
+    ],
+  },
+  {
+    platform: 'douyin',
+    command: 'user-profile',
+    description: '抖音作者主页信息查询，默认使用 sec_user_id。',
+    method: 'GET',
+    socialPath: '/douyin/web/handler_user_profile',
+    positionals: [{ name: 'sec_user_id', label: '作者 sec_user_id' }],
+    options: [],
+    returns: '返回作者昵称、头像、简介、粉丝关注统计、账号状态等用户资料字段。',
+    alternatives: [
+      'GET /social/douyin/web/handler_user_profile_v2?unique_id=...',
+      'GET /social/douyin/web/fetch_user_profile_by_uid?uid=...',
+    ],
+  },
+  {
+    platform: 'douyin',
+    command: 'user-posts',
+    description: '抖音作者主页作品采集。',
+    method: 'GET',
+    socialPath: '/douyin/web/fetch_user_post_videos',
+    positionals: [{ name: 'sec_user_id', label: '作者 sec_user_id' }],
+    options: [
+      { flag: 'cursor', name: 'max_cursor', label: '翻页游标' },
+      { flag: 'count', name: 'count', label: '返回数量' },
+      { flag: 'filter-type', name: 'filter_type', label: '筛选类型' },
+      { flag: 'cookie', name: 'cookie', label: '可选 Cookie' },
+    ],
+    returns: '返回作品列表、下一页游标、作者与作品基础字段，适合循环翻页采集。',
+    alternatives: ['GET /social/douyin/app/v3/fetch_user_post_videos'],
+  },
+  {
+    platform: 'douyin',
+    command: 'comments',
+    description: '抖音作品评论采集。',
+    method: 'GET',
+    socialPath: '/douyin/web/fetch_video_comments',
+    positionals: [{ name: 'aweme_id', label: '作品 aweme_id' }],
+    options: [
+      { flag: 'cursor', name: 'cursor', label: '翻页游标' },
+      { flag: 'count', name: 'count', label: '返回数量' },
+    ],
+    returns: '返回评论列表、用户信息、评论统计和下一页游标。',
+    alternatives: ['GET /social/douyin/app/v3/fetch_video_comments'],
+  },
+  {
+    platform: 'douyin',
+    command: 'hot-search',
+    description: '抖音热榜数据。',
+    method: 'GET',
+    socialPath: '/douyin/web/fetch_hot_search_result',
+    positionals: [],
+    options: [],
+    returns: '返回热榜条目、热度、排名等字段。',
+    alternatives: [],
+  },
+  {
+    platform: 'xiaohongshu',
+    command: 'note-detail',
+    description: '小红书笔记详情查询。',
+    method: 'GET',
+    socialPath: '/xiaohongshu/web_v3/fetch_note_detail',
+    positionals: [{ name: 'note_id', label: '笔记 ID' }],
+    options: [{ flag: 'xsec-token', name: 'xsec_token', label: 'xsec_token，可选' }],
+    returns: '返回笔记正文、作者、图片/视频媒体、互动统计等字段。',
+    alternatives: ['GET /social/xiaohongshu/web/get_note_id_and_xsec_token?share_text=...'],
+  },
+  {
+    platform: 'xiaohongshu',
+    command: 'note-comments',
+    description: '小红书笔记评论采集。',
+    method: 'GET',
+    socialPath: '/xiaohongshu/web_v3/fetch_note_comments',
+    positionals: [{ name: 'note_id', label: '笔记 ID' }],
+    options: [{ flag: 'cursor', name: 'cursor', label: '翻页游标' }],
+    returns: '返回评论列表、用户信息和下一页游标。',
+    alternatives: ['GET /social/xiaohongshu/web_v3/fetch_sub_comments'],
+  },
+  {
+    platform: 'xiaohongshu',
+    command: 'search-notes',
+    description: '小红书笔记搜索。',
+    method: 'GET',
+    socialPath: '/xiaohongshu/web_v3/fetch_search_notes',
+    positionals: [{ name: 'keyword', label: '关键词' }],
+    options: [
+      { flag: 'page', name: 'page', label: '页码' },
+      { flag: 'sort', name: 'sort', label: '排序方式' },
+      { flag: 'note-type', name: 'note_type', label: '笔记类型' },
+    ],
+    returns: '返回搜索结果列表、笔记摘要、作者和分页信息。',
+    alternatives: ['GET /social/xiaohongshu/web/search_notes_v3'],
+  },
+  {
+    platform: 'xiaohongshu',
+    command: 'search-users',
+    description: '小红书用户搜索。',
+    method: 'GET',
+    socialPath: '/xiaohongshu/web_v3/fetch_search_users',
+    positionals: [{ name: 'keyword', label: '关键词' }],
+    options: [{ flag: 'page', name: 'page', label: '页码' }],
+    returns: '返回用户列表、头像、简介、关注粉丝等摘要字段。',
+    alternatives: ['GET /social/xiaohongshu/web/search_users'],
+  },
+  {
+    platform: 'xiaohongshu',
+    command: 'user-notes',
+    description: '小红书作者主页笔记采集。',
+    method: 'GET',
+    socialPath: '/xiaohongshu/web/get_user_notes_v2',
+    positionals: [{ name: 'user_id', label: '作者 user_id' }],
+    options: [{ flag: 'cursor', name: 'lastCursor', label: '翻页游标' }],
+    returns: '返回作者笔记列表和下一页游标。',
+    alternatives: [],
+  },
+  {
+    platform: 'bilibili',
+    command: 'video-detail',
+    description: 'B站视频详情，支持视频 URL。',
+    method: 'GET',
+    socialPath: '/bilibili/web/fetch_one_video_v3',
+    positionals: [{ name: 'url', label: '视频链接' }],
+    options: [],
+    returns: '返回视频标题、UP主、分P、统计、封面等基础信息。',
+    alternatives: [
+      'GET /social/bilibili/web/fetch_one_video?bv_id=...',
+      'GET /social/bilibili/app/fetch_one_video?bv_id=...',
+    ],
+  },
+  {
+    platform: 'bilibili',
+    command: 'video-download',
+    description: 'B站视频播放信息查询，常用于获取可播放媒体信息。',
+    method: 'GET',
+    socialPath: '/bilibili/web/fetch_video_play_info',
+    positionals: [{ name: 'url', label: '视频链接' }],
+    options: [],
+    returns: '返回视频播放信息；如需要指定 cid，可改用 video-playurl。',
+    alternatives: ['GET /social/bilibili/web/fetch_video_playurl?bv_id=...&cid=...'],
+  },
+  {
+    platform: 'bilibili',
+    command: 'video-playurl',
+    description: 'B站按 BV 号和 cid 获取视频流地址。',
+    method: 'GET',
+    socialPath: '/bilibili/web/fetch_video_playurl',
+    positionals: [
+      { name: 'bv_id', label: 'BV 号' },
+      { name: 'cid', label: '分P cid' },
+    ],
+    options: [],
+    returns: '返回视频流地址与清晰度相关信息。',
+    alternatives: ['GET /social/bilibili/web/fetch_video_play_info?url=...'],
+  },
+  {
+    platform: 'bilibili',
+    command: 'user-profile',
+    description: 'B站 UP 主信息查询。',
+    method: 'GET',
+    socialPath: '/bilibili/web/fetch_user_profile',
+    positionals: [{ name: 'uid', label: 'UP 主 uid' }],
+    options: [],
+    returns: '返回昵称、头像、简介、等级等用户资料。',
+    alternatives: ['GET /social/bilibili/app/fetch_user_info?user_id=...'],
+  },
+  {
+    platform: 'bilibili',
+    command: 'user-posts',
+    description: 'B站 UP 主投稿视频采集。',
+    method: 'GET',
+    socialPath: '/bilibili/web/fetch_user_post_videos',
+    positionals: [{ name: 'uid', label: 'UP 主 uid' }],
+    options: [
+      { flag: 'page', name: 'pn', label: '页码' },
+      { flag: 'order', name: 'order', label: '排序方式' },
+    ],
+    returns: '返回投稿视频列表、分页和视频摘要字段。',
+    alternatives: ['GET /social/bilibili/app/fetch_user_videos?user_id=...'],
+  },
+  {
+    platform: 'bilibili',
+    command: 'search',
+    description: 'B站综合搜索。',
+    method: 'GET',
+    socialPath: '/bilibili/web/fetch_general_search',
+    positionals: [{ name: 'keyword', label: '关键词' }],
+    options: [
+      { flag: 'order', name: 'order', label: '排序，默认 totalrank' },
+      { flag: 'page', name: 'page', label: '页码，默认 1' },
+      { flag: 'page-size', name: 'page_size', label: '每页数量，默认 20' },
+      { flag: 'duration', name: 'duration', label: '时长筛选' },
+    ],
+    defaults: { order: 'totalrank', page: '1', page_size: '20' },
+    returns: '返回搜索结果、视频摘要、UP主摘要和分页字段。',
+    alternatives: ['GET /social/bilibili/app/fetch_search_all'],
+  },
+  {
+    platform: 'bilibili',
+    command: 'comments',
+    description: 'B站视频评论采集。',
+    method: 'GET',
+    socialPath: '/bilibili/web/fetch_video_comments',
+    positionals: [{ name: 'bv_id', label: 'BV 号' }],
+    options: [{ flag: 'page', name: 'pn', label: '页码' }],
+    returns: '返回评论列表、用户信息、互动统计和分页信息。',
+    alternatives: ['GET /social/bilibili/app/fetch_video_comments'],
+  },
+  {
+    platform: 'wechat',
+    command: 'channels-search',
+    description: '微信视频号综合搜索。',
+    method: 'GET',
+    socialPath: '/wechat_channels/fetch_search_ordinary',
+    positionals: [{ name: 'keywords', label: '关键词' }],
+    options: [],
+    returns: '返回视频号综合搜索结果。',
+    alternatives: ['GET /social/wechat_channels/fetch_search_latest?keywords=...'],
+  },
+  {
+    platform: 'wechat',
+    command: 'channels-latest',
+    description: '微信视频号最新视频搜索。',
+    method: 'GET',
+    socialPath: '/wechat_channels/fetch_search_latest',
+    positionals: [{ name: 'keywords', label: '关键词' }],
+    options: [],
+    returns: '返回按最新排序的视频号搜索结果。',
+    alternatives: ['GET /social/wechat_channels/fetch_search_ordinary?keywords=...'],
+  },
+  {
+    platform: 'wechat',
+    command: 'channels-user-search',
+    description: '微信视频号用户搜索。',
+    method: 'GET',
+    socialPath: '/wechat_channels/fetch_user_search',
+    positionals: [{ name: 'keywords', label: '关键词' }],
+    options: [{ flag: 'page', name: 'page', label: '页码' }],
+    returns: '返回视频号用户搜索结果和分页信息。',
+    alternatives: ['GET /social/wechat_channels/fetch_user_search_v2'],
+  },
+  {
+    platform: 'wechat',
+    command: 'channels-video-detail',
+    description: '微信视频号视频详情。',
+    method: 'GET',
+    socialPath: '/wechat_channels/fetch_video_detail',
+    positionals: [{ name: 'id', label: '视频 ID' }],
+    options: [{ flag: 'export-id', name: 'exportId', label: 'exportId，可选' }],
+    returns: '返回视频号视频详情、作者和媒体相关字段。',
+    alternatives: [],
+  },
+  {
+    platform: 'wechat',
+    command: 'channels-home',
+    description: '微信视频号主页采集，参数结构通常需要用 --json 传入上游要求的完整请求体。',
+    method: 'POST',
+    socialPath: '/wechat_channels/fetch_home_page',
+    positionals: [],
+    options: [],
+    returns: '返回视频号主页资料和作品列表，具体字段取决于请求体。',
+    alternatives: [],
+  },
+  {
+    platform: 'wechat',
+    command: 'mp-article-detail',
+    description: '微信公众号文章详情 JSON。',
+    method: 'GET',
+    socialPath: '/wechat_mp/web/fetch_mp_article_detail_json',
+    positionals: [{ name: 'url', label: '文章链接' }],
+    options: [],
+    returns: '返回公众号文章标题、正文结构、作者、发布时间等 JSON 字段。',
+    alternatives: ['GET /social/wechat_mp/web/fetch_mp_article_detail_html?url=...'],
+  },
+  {
+    platform: 'wechat',
+    command: 'mp-article-html',
+    description: '微信公众号文章详情 HTML。',
+    method: 'GET',
+    socialPath: '/wechat_mp/web/fetch_mp_article_detail_html',
+    positionals: [{ name: 'url', label: '文章链接' }],
+    options: [],
+    returns: '返回公众号文章 HTML 内容。',
+    alternatives: ['GET /social/wechat_mp/web/fetch_mp_article_detail_json?url=...'],
+  },
+  {
+    platform: 'wechat',
+    command: 'mp-article-list',
+    description: '微信公众号文章列表采集。',
+    method: 'GET',
+    socialPath: '/wechat_mp/web/fetch_mp_article_list',
+    positionals: [{ name: 'ghid', label: '公众号 ghid' }],
+    options: [{ flag: 'offset', name: 'offset', label: '偏移量' }],
+    returns: '返回公众号文章列表和分页偏移信息。',
+    alternatives: [],
+  },
+  {
+    platform: 'wechat',
+    command: 'mp-comments',
+    description: '微信公众号文章评论采集。',
+    method: 'GET',
+    socialPath: '/wechat_mp/web/fetch_mp_article_comment_list',
+    positionals: [{ name: 'url', label: '文章链接' }],
+    options: [
+      { flag: 'comment-id', name: 'comment_id', label: 'comment_id，可选' },
+      { flag: 'buffer', name: 'buffer', label: '分页 buffer，可选' },
+    ],
+    returns: '返回文章评论列表、用户信息和分页 buffer。',
+    alternatives: ['GET /social/wechat_mp/web/fetch_mp_article_comment_reply_list'],
+  },
+];
+
+export function findShortcut(platform, command) {
+  return shortcuts.find((shortcut) => shortcut.platform === platform && shortcut.command === command);
+}
+
+export function listShortcuts(platform) {
+  return shortcuts.filter((shortcut) => (platform ? shortcut.platform === platform : true));
+}

package/cli.js

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-
-import "./src/ycloud/cli.js";

package/src/ycloud/cli.js

@@ -1,29 +0,0 @@
-#!/usr/bin/env node
-
-import { executeCommand } from "./commands/index.js";
-
-const args = process.argv.slice(2);
-
-try {
-  const { code, output } = await executeCommand(args);
-  process.stdout.write(output);
-  process.exitCode = code;
-} catch (error) {
-  const mappedCode = error?.code || "INTERNAL_ERROR";
-  const mappedExitCode = error?.exitCode || 1;
-  const mappedRetryable = error?.retryable || false;
-  const payload = {
-    success: false,
-    command: args.slice(0, 2).join(" ").trim() || "unknown",
-    data: null,
-    warnings: [],
-    error: {
-      code: mappedCode,
-      message: error instanceof Error ? error.message : String(error),
-      retryable: mappedRetryable,
-    },
-    meta: {},
-  };
-  process.stdout.write(`${JSON.stringify(payload)}\n`);
-  process.exitCode = mappedExitCode;
-}

package/src/ycloud/commands/analysis.js

@@ -1,82 +0,0 @@
-import { apiPost } from "../core/http.js";
-import { getToken } from "../core/token.js";
-import { getGlobalFlagsHelp, parseInteger } from "./shared.js";
-
-export function getAnalysisHelp(subcommand) {
-  if (subcommand === "creator-profile") {
-    return `Analyze creator profile
-
-Usage:
-  ycloud analysis creator-profile [flags]
-
-Required Flags:
-  --profile-url string   creator profile share URL
-
-Optional Flags:
-  --video-limit int      number of videos to analyze (default 20)
-
-${getGlobalFlagsHelp()}
-
-Examples:
-  ycloud analysis creator-profile --profile-url "https://v.douyin.com/xxxx/" --video-limit 20 --output json
-
-Read on success:
-  data.profile
-  data.insights
-
-Read on error:
-  error.code
-  error.message
-  error.retryable`;
-  }
-
-  return `Analysis commands
-
-Usage:
-  ycloud analysis <creator-profile> [flags]`;
-}
-
-async function requireToken(context) {
-  const token = await getToken();
-  if (!token) {
-    return context.fail(
-      context.commandName,
-      "TOKEN_MISSING",
-      "缺少 YUANCHUANG_API_TOKEN",
-      3,
-      false,
-    );
-  }
-  return token;
-}
-
-export async function executeAnalysisCreatorProfile(context, tokens) {
-  const options = context.parseCommandFlags(tokens);
-  if (!options["profile-url"]) {
-    return context.fail(
-      "analysis creator-profile",
-      "BAD_ARGUMENT",
-      "缺少必填参数 --profile-url",
-      2,
-      false,
-    );
-  }
-
-  const token = await requireToken(context);
-  if (typeof token !== "string") {
-    return token;
-  }
-
-  const data = await apiPost("/v1/analysis/douyin/creator-profile", {
-    token,
-    traceId: context.globalOptions.traceId,
-    timeout: context.globalOptions.timeout,
-    baseUrl: context.globalOptions.baseUrl,
-    body: {
-      profile_url: options["profile-url"],
-      video_limit: parseInteger(options["video-limit"]) ?? 20,
-    },
-  });
-
-  return context.ok("analysis creator-profile", data);
-}

package/src/ycloud/commands/auth.js

@@ -1,191 +0,0 @@
-import { apiGet } from "../core/http.js";
-import { getConfigPath, maskToken } from "../core/config.js";
-import { getToken, getTokenWithSource } from "../core/token.js";
-import { getGlobalFlagsHelp, parseInteger } from "./shared.js";
-
-export function getAuthHelp(subcommand) {
-  if (subcommand === "validate") {
-    return `Validate current API token
-
-Usage:
-  ycloud auth validate [flags]
-
-Optional Flags:
-  none
-
-${getGlobalFlagsHelp()}
-
-Examples:
-  ycloud auth validate --output json
-
-Read on success:
-  success
-  data
-
-Read on error:
-  error.code
-  error.message
-  error.retryable`;
-  }
-
-  if (subcommand === "info") {
-    return `Get current token account info
-
-Usage:
-  ycloud auth info [flags]
-
-Optional Flags:
-  none
-
-${getGlobalFlagsHelp()}
-
-Examples:
-  ycloud auth info --output json
-
-Read on success:
-  data
-
-Read on error:
-  error.code
-  error.message
-  error.retryable`;
-  }
-
-  if (subcommand === "charges") {
-    return `List token billing charge records
-
-Usage:
-  ycloud auth charges [flags]
-
-Optional Flags:
-  --model-id string      filter by model id
-  --charge-type string   filter by charge type
-  --user-level string    filter by user level
-  --start-at string      ISO datetime start
-  --end-at string        ISO datetime end
-  --limit int            page size, default 20
-  --offset int           offset, default 0
-
-${getGlobalFlagsHelp()}
-
-Examples:
-  ycloud auth charges --limit 20 --output json
-
-Read on success:
-  data
-
-Read on error:
-  error.code
-  error.message
-  error.retryable`;
-  }
-
-  if (subcommand === "status") {
-    return `Show current token source and masked token
-
-Usage:
-  ycloud auth status [flags]
-
-Optional Flags:
-  none
-
-${getGlobalFlagsHelp()}
-`;
-  }
-
-  return `Auth commands
-
-Usage:
-  ycloud auth <validate|info|charges|status> [flags]`;
-}
-
-async function requireToken(context) {
-  const token = await getToken();
-  if (!token) {
-    return context.fail(
-      context.commandName,
-      "TOKEN_MISSING",
-      "缺少 YUANCHUANG_API_TOKEN",
-      3,
-      false,
-    );
-  }
-  return token;
-}
-
-export async function executeAuthInfo(context) {
-  const token = await requireToken(context);
-  if (typeof token !== "string") {
-    return token;
-  }
-  const data = await apiGet("/v1/auth/info", {
-    token,
-    traceId: context.globalOptions.traceId,
-    timeout: context.globalOptions.timeout,
-    baseUrl: context.globalOptions.baseUrl,
-  });
-  return context.ok("auth info", data);
-}
-
-export async function executeAuthValidate(context) {
-  const token = await requireToken(context);
-  if (typeof token !== "string") {
-    return token;
-  }
-  const data = await apiGet("/v1/auth/validate", {
-    token,
-    traceId: context.globalOptions.traceId,
-    timeout: context.globalOptions.timeout,
-    baseUrl: context.globalOptions.baseUrl,
-  });
-  return context.ok("auth validate", data);
-}
-
-export async function executeAuthCharges(context, tokens) {
-  const token = await requireToken(context);
-  if (typeof token !== "string") {
-    return token;
-  }
-
-  const options = context.parseCommandFlags(tokens);
-  const query = new URLSearchParams();
-  const mapping = {
-    "model-id": "model_id",
-    "charge-type": "charge_type",
-    "user-level": "user_level",
-    "start-at": "start_at",
-    "end-at": "end_at",
-  };
-
-  for (const [flag, field] of Object.entries(mapping)) {
-    if (options[flag] !== undefined) {
-      query.set(field, String(options[flag]));
-    }
-  }
-
-  if (options.limit !== undefined) {
-    query.set("limit", String(parseInteger(options.limit) ?? 20));
-  }
-  if (options.offset !== undefined) {
-    query.set("offset", String(parseInteger(options.offset) ?? 0));
-  }
-
-  const suffix = query.toString() ? `?${query.toString()}` : "";
-  const data = await apiGet(`/v1/auth/charges${suffix}`, {
-    token,
-    traceId: context.globalOptions.traceId,
-    timeout: context.globalOptions.timeout,
-    baseUrl: context.globalOptions.baseUrl,
-  });
-  return context.ok("auth charges", data);
-}
-
-export async function executeAuthStatus(context) {
-  const { token, source } = await getTokenWithSource();
-  return context.ok("auth status", {
-    token_present: Boolean(token),
-    token_source: source,
-    token_masked: maskToken(token),
-    config_path: getConfigPath(),
-  });
-}