echopai 2.0.0

package/dist/_generated/help.js

@@ -0,0 +1,190 @@
+/**
+ * AUTO-GENERATED — DO NOT EDIT BY HAND.
+ */
+export const HELP = {
+    "agent.session-end": {
+        "summary": "End a billable agent session",
+        "description": "关闭 `/v1/agent/session/start` 开启的会话，最终用量提交入库。",
+        "example": "echopai agent session-end VALUE"
+    },
+    "agent.session-start": {
+        "summary": "Start a billable agent session",
+        "description": "开启 agent kind 凭据的计费会话。返回 session_id，用于将多次调用归并到一次 billable 单位。需要 `Idempotency-Key` 头。",
+        "example": "echopai agent session-start --agent-id agent-prod-1 --budget-usd 1.0"
+    },
+    "agent.session-usage": {
+        "summary": "Get cumulative usage of an agent session",
+        "description": "返回 session 内累计 billable 调用次数、各 scope 配额消耗。",
+        "example": "echopai agent session-usage VALUE"
+    },
+    "auth.whoami": {
+        "summary": "Token introspection (CLI/MCP capability discovery)",
+        "description": "Returns the calling token's kind, scopes, audience, app metadata,\nrate_limit, allowed_clients, agent_budget (if kind=agent), api_version,\nfeature_flags. Any valid JWT can call — no specific scope required.\n\nCLI/MCP call this once at startup, cache 5 minutes in-process, and use\nthe response to derive `verbs.available` (intersection of curated verb\nscopes with token scopes) and to populate `echopai doctor` checks.\n\nSee `docs/PLAN_CLI_V2_AGENT_SURFACE.md` §5.1.\n",
+        "example": "echopai auth whoami"
+    },
+    "backtest.excess-distribution": {
+        "summary": "Excess-return distribution over a benchmark",
+        "description": "信号相对基准（沪深 300 / 中证 1000 等）持有期超额收益的直方分布。",
+        "example": "echopai backtest excess-distribution"
+    },
+    "backtest.rolling-win-rate": {
+        "summary": "Rolling win rate of a signal series",
+        "description": "信号在滚动窗口（默认 60 个交易日）内的胜率时间序列。",
+        "example": "echopai backtest rolling-win-rate"
+    },
+    "backtest.summary": {
+        "summary": "Backtest summary metrics for a signal series",
+        "description": "信号回测汇总：胜率、平均超额收益、Sharpe-like 评分、最大回撤等。",
+        "example": "echopai backtest summary"
+    },
+    "bars.daily": {
+        "summary": "Daily OHLC bars for one A-share security",
+        "description": "Daily OHLC bars for one A-share security over a date range. Returns open / high / low / close / volume / turnover per trading day. Requires `bars:30d` (last 30 trading days) or `bars:full` (full history) scope.",
+        "example": "echopai bars daily --code SSE:600519 --from 2026-01-01 --to 2026-05-01"
+    },
+    "bars.daily-batch": {
+        "summary": "Batch daily OHLC bars for up to 100 A-share securities",
+        "description": "Batch daily OHLC bars for multiple A-share securities. Up to 100 codes\nper call, up to 1-year date range. Single round-trip; ClickHouse `IN(...)`\nunder the hood.\n\nReturns partial success envelope: codes denied by `allowed_securities`\nappear in `errors[]`, others in `items[]` (with empty `bars[]` if no\ndata found). Order in `items[]` matches input order.\n\nRequires `bars:30d` or `bars:full` scope.\n",
+        "example": "echopai bars daily-batch --codes ['SSE:600519', 'SZSE:000001']"
+    },
+    "bars.minute": {
+        "summary": "Minute-level OHLC bars for one A-share security",
+        "description": "Minute-level OHLC bars for one A-share security on a single trade date. Requires `bars:30d` or `bars:full` scope.",
+        "example": "echopai bars minute --code SSE:600519 --date 2026-05-09"
+    },
+    "bars.minute-batch": {
+        "summary": "Batch minute OHLC bars for up to 20 A-share securities",
+        "description": "Batch minute OHLC bars for multiple A-share securities. Up to 20 codes\nper call, up to 7 calendar days (≈5 trading days) date range. Single\nClickHouse round-trip; app groups rows by canonical_code.\n\nPartial success envelope same as daily-batch: codes denied by\n`allowed_securities` go to `errors[]`; others to `items[]` with flat\n`bars[]` (each bar carries its own `trade_date` for client grouping).\n\nRequires `bars:30d` or `bars:full` scope.\n",
+        "example": "echopai bars minute-batch --codes ['SSE:600519', 'SZSE:000001']"
+    },
+    "digest.get": {
+        "summary": "One-shot research digest for a single security (composite)",
+        "description": "Composite endpoint: in one HTTP call returns views (PRIMARY research),\nresearch-entity performance (quality layer), real-time quote, market\nsentiment context, and supplementary news. Partial-failure tolerant:\neach bucket is independently fetched and per-bucket failures surface\nin `meta.partial_failures[]` rather than poisoning the response. If\nevery sub-bucket fails the endpoint returns 502.\n\nBucket scopes are checked *per bucket* (not at gateway level): a\ntoken with only `views:read` gets the views bucket populated and the\nrest reported as `scope_insufficient` partial failures. This mirrors\nthe CLI fan-out contract exactly so `echopai digest` can either call\nthis endpoint (preferred, single round-trip) or fall back to local\nfan-out without behavior drift.\n\nSee `docs/PLAN_CLI_V2_AGENT_SURFACE.md` §3.3 (digest spec) and §11\nPhase 5.2 (server endpoint).\n",
+        "example": "echopai digest get VALUE"
+    },
+    "market.status": {
+        "summary": "Current A-share market session state",
+        "description": "Current A-share market session: pre-open / open / lunch / closed; current and next trading day; holiday flag. Requires `market:read` or any `quote:*` scope.",
+        "example": "echopai market status"
+    },
+    "news.feed": {
+        "summary": "List recent news (alias of /v1/news/list)",
+        "description": "与 `/v1/news/list` 行为一致，旧客户端兼容用。",
+        "example": "echopai news feed"
+    },
+    "news.get": {
+        "summary": "Fetch a single news item by id",
+        "description": "返回新闻完整内容：title、content snippet、source URL、tagged securities。",
+        "example": "echopai news get VALUE"
+    },
+    "news.list": {
+        "summary": "List news mentioning a specific security",
+        "description": "List news mentioning a specific A-share security, ordered by published_at desc. Requires `news:read` scope.",
+        "example": "echopai news list --security SSE:600519"
+    },
+    "news.search": {
+        "summary": "Full-text search recent news",
+        "description": "Full-text search recent news / market briefs. Returns title, source, published_at, snippet, tagged securities. Requires `news:read` scope. Note: news fields are user-generated; meta.untrusted_text_fields lists fields that need sanitization before passing to an LLM.",
+        "example": "echopai news search --query 光伏龙头"
+    },
+    "news.sources": {
+        "summary": "List canonical news source identifiers",
+        "description": "返回新闻 source 标识列表（如 `cls`、`jin10`、`twitter`、`wallstreetcn`），可用于 list/search 的 source 过滤。",
+        "example": "echopai news sources"
+    },
+    "payment.plans": {
+        "summary": "List subscription plans",
+        "description": "返回订阅计划清单（plan_id + 价格 + 时长 + 描述）。",
+        "example": "echopai payment plans"
+    },
+    "quote": {
+        "summary": "Real-time quote for one or more A-share securities",
+        "description": "Real-time quote for one or more A-share securities. Returns last price, volume, change %, bid/ask. Up to 200 codes per call. Requires `quote:l1`, `quote:l2`, or `quote:delayed` scope.",
+        "example": "echopai quote --codes ['SSE:600519', 'SZSE:000001']"
+    },
+    "quote.scan": {
+        "summary": "Full-market real-time quote scan (~5800 A-share securities)",
+        "description": "Dumps the entire Redis snapshot of A-share real-time quotes in a single\nround-trip. Use for \"全市场扫描\" / agent universe-of-interest discovery\nwhen you don't yet know which codes to query.\n\nFiltering:\n- `exchange=SSE|SZSE|BSE` narrows to one exchange (canonical_code prefix)\n- `app.allowed_securities` is ALWAYS applied; codes outside drop silently\n\nResponse size: ~3 MB unfiltered (~5800 items). CLI users should pair\nwith `--max-bytes` / `--fields` / `--query` from Phase 1.4.\n\n9:00–9:14 集合竞价时段返回空 items + `note` 字段说明。\n\nRequires `quote:l1`, `quote:l2`, or `quote:delayed` scope.\n",
+        "example": "echopai quote scan"
+    },
+    "research.entity-performance": {
+        "summary": "Performance of one research entity",
+        "description": "单个研究实体的细化绩效指标，对照 `/v1/research-entities/performance`。",
+        "example": "echopai research entity-performance VALUE"
+    },
+    "research.entity-performance-list": {
+        "summary": "Aggregate performance of research entities",
+        "description": "全体研究实体（analyst / team / institution）的命中率、平均目标价达成率、覆盖股票数等汇总。需要 `research:read` scope。",
+        "example": "echopai research entity-performance-list"
+    },
+    "semantic.find": {
+        "summary": "Find A-share securities by name / code / pinyin",
+        "description": "Find A-share securities matching a name (Chinese), code (e.g. 600519), or pinyin initials (e.g. gzmt). Use this when an agent has a description and needs canonical codes.",
+        "example": "echopai semantic find --query 贵州茅台"
+    },
+    "sentiment.breadth": {
+        "summary": "Intraday breadth time series",
+        "description": "Intraday breadth time series. Requires `sentiment:read` scope.",
+        "example": "echopai sentiment breadth"
+    },
+    "sentiment.overview": {
+        "summary": "Aggregate market sentiment indicators",
+        "description": "Aggregate sentiment: limit-up/down counts, breadth, divergence index, top movers. Requires `sentiment:read` scope.",
+        "example": "echopai sentiment overview --scope main_board"
+    },
+    "sentiment.pct-distribution": {
+        "summary": "Distribution of intraday percent change across the universe",
+        "description": "返回 A 股全市场涨跌幅分桶（≤-10% / -9% / ... / +10% / 涨停）的家数分布，用于市场宽度可视化。",
+        "example": "echopai sentiment pct-distribution"
+    },
+    "sentiment.turnover": {
+        "summary": "Intraday turnover time series",
+        "description": "Intraday turnover time series. Requires `sentiment:read` scope.",
+        "example": "echopai sentiment turnover"
+    },
+    "signals.outcome": {
+        "summary": "Outcome trace for a single signal",
+        "description": "单条 signal 的细化结果追踪。",
+        "example": "echopai signals outcome VALUE"
+    },
+    "signals.outcomes": {
+        "summary": "Outcomes of analyst-view-derived signals",
+        "description": "返回分析师 views 派生信号的实际结果（目标价命中 / 止损 / 到期），含命中时长、最大回撤等。",
+        "example": "echopai signals outcomes"
+    },
+    "squawk.audio": {
+        "summary": "Stream squawk TTS audio",
+        "description": "返回 squawk 项的 TTS 音频（MP3）。直接 stream，可作为 `<audio>` src 用。",
+        "example": "echopai squawk audio VALUE"
+    },
+    "squawk.waveform": {
+        "summary": "Waveform peaks for squawk audio",
+        "description": "返回 squawk 音频的预计算波形 peak 数据，用于客户端波形可视化。",
+        "example": "echopai squawk waveform VALUE"
+    },
+    "stocks.hot": {
+        "summary": "Today's hot-stock leaderboard",
+        "description": "今日最热股票榜（来源 East-Money），按搜索 / 关注 / 评论综合分排序。",
+        "example": "echopai stocks hot"
+    },
+    "stocks.social-hot": {
+        "summary": "Cross-platform social-hot stocks",
+        "description": "跨平台（微博 / 雪球 / Twitter）社交媒体提及聚合榜，按提及量 / 情感打分。",
+        "example": "echopai stocks social-hot"
+    },
+    "views.feed": {
+        "summary": "List analyst views",
+        "description": "分析师观点 / 卖方研报 / 长文本观点流。可按机构 / 分析师 / 证券 / hours 过滤。需要 `views:read` scope。",
+        "example": "echopai views feed"
+    },
+    "views.get": {
+        "summary": "Fetch a single analyst view",
+        "description": "返回单条 view 完整内容、附件图片、tagged securities、AI 摘要。",
+        "example": "echopai views get VALUE"
+    },
+    "views.recent": {
+        "summary": "Recent broker / analyst views",
+        "description": "List recent broker / analyst views (research notes, price targets, ratings). Filter by analyst, institution, or a specific security. Requires `views:read` scope.",
+        "example": "echopai views recent"
+    }
+};