Back to Details

keq-cli

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Keq CLI — @keq-request/cli

Keq CLI — @keq-request/cli

CLI tool that compiles OpenAPI/Swagger documents into type-safe TypeScript request functions. Also provides mock server and semantic API search.
一款将OpenAPI/Swagger文档编译为类型安全的TypeScript请求函数的CLI工具，同时提供mock服务器和语义API搜索功能。

When to Consult Which Reference

何时查阅对应参考文档

  • First time setting up or need to install → setup.md
  • Configuring 
    .keqrc
     (modules, rendering, translators, plugins) → keqrc.md
  • Need to filter which APIs get generated (large spec, only need a subset) → keqfilter.md
  • Generating code from OpenAPI specs (
    keq build
    ) → commands.md § keq build
  • Discovering available backend APIs for current task (semantic search by intent/description) → commands.md § keq search
  • Listing all APIs or components in a module (
    keq apis
    ) → commands.md § keq apis
  • Other CLI commands (mock, filter, etc.) → commands.md
  • Customizing code generation output (file structure, translator selection) → translators.md
  • Generated code doesn't meet expectations or needs enhancement (formatting, naming, validation, compatibility, etc.) → plugins.md
  • 首次搭建或需要安装 → setup.md
  • 配置
    .keqrc
    （模块、渲染器、转换器、插件）→ keqrc.md
  • 需要筛选要生成的API（大型规范，仅需子集）→ keqfilter.md
  • 从OpenAPI规范生成代码（
    keq build
    ）→ commands.md § keq build
  • 为当前任务查找可用的后端API（按意图/描述进行语义搜索）→ commands.md § keq search
  • 列出模块中的所有API或组件（
    keq apis
    ）→ commands.md § keq apis
  • 其他CLI命令（mock、filter等）→ commands.md
  • 自定义代码生成输出（文件结构、转换器选择）→ translators.md
  • 生成的代码不符合预期或需要增强（格式、命名、验证、兼容性等）→ plugins.md