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

      • @lynx-js/create-lynxtron

      create-lynxtron initializes a Lynxtron application from the official template. It copies the template, writes the project name, replaces workspace dependency versions in the generated package.json, and keeps or removes Web support code based on the selected option.

      The package name is @lynx-js/create-lynxtron. Use npm create @lynx-js/lynxtron@latest to create a project.

      Usage

      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

      Arguments

      ArgumentDescription
      [project-name]The project name or target path. If omitted, the CLI prompts for it and defaults to lynxtron-app.
      --webInclude Web support by default, including Symmetric Host related code.
      --no-webGenerate the project without Web support code.

      Behavior

      • If the project name or Web support option is omitted, the CLI prompts for it.
      • If the target directory already exists and is not empty, the CLI asks before overwriting it.
      • The default template is a Lynxtron desktop app template with a Node.js main process and Lynx UI code.
      • After generation, run npm install and npm run dev to start development.
      Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.