For AI agents: the complete documentation index is available at /next/zh/llms.txt, the full documentation bundle is available at /next/zh/llms-full.txt, and this page is available as Markdown at /next/zh/lynxtron/api/@lynx-js/create-lynxtron/index.md.
  • 简体中文
  • @lynx-js/create-lynxtron

    create-lynxtron 是 Lynxtron 官方应用模板的项目初始化器。它会复制模板、写入项目名、替换模板中的 workspace 依赖版本,并根据选项保留或移除 Web 支持相关代码。

    发布包名为 @lynx-js/create-lynxtron,推荐通过 npm create @lynx-js/lynxtron@latest 创建项目。

    用法

    npm create @lynx-js/lynxtron@latest my-app
    npm create @lynx-js/lynxtron@latest my-app -- --web
    npm create @lynx-js/lynxtron@latest my-app -- --no-web

    参数

    参数说明
    [project-name]要创建的项目名或目标路径。未传入时会交互式询问,默认值为 lynxtron-app
    --web默认包含 Web 支持,也就是生成 Symmetric Host 相关代码。
    --no-web不生成 Web 支持相关代码。

    行为

    • 如果没有传入项目名或 Web 支持选项,CLI 会进入交互式询问。
    • 如果目标目录已存在且不为空,CLI 会询问是否覆盖。
    • 默认模板是 Lynxtron 桌面应用模板,包含 Node.js 主进程和 Lynx UI 代码。
    • 生成完成后,通常执行 npm installnpm run dev 开始开发。
    除非另有说明,本项目采用知识共享署名 4.0 国际许可协议进行许可,代码示例采用 Apache License 2.0 许可协议进行许可。