# 命令行开发工具

**Repository Path**: lcui-dev/lcui-cli

## Basic Information

- **Project Name**: 命令行开发工具
- **Description**: 用于开发 LCUI 应用程序的命令行工具
- **Primary Language**: NodeJS
- **License**: MIT
- **Default Branch**: develop
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 12
- **Forks**: 2
- **Created**: 2019-10-07
- **Last Updated**: 2025-01-07

## Categories & Tags

**Categories**: desktop-ui

**Tags**: None

## README

# lcui-cli

[![GitHub Actions](https://github.com/lc-ui/lcui-cli/workflows/Node.js%20CI/badge.svg)](https://github.com/lc-ui/lcui-cli/actions)
[![codecov](https://codecov.io/gh/lc-ui/lcui-cli/branch/master/graph/badge.svg?token=USK2SXHC86)](https://codecov.io/gh/lc-ui/lcui-cli)

## 简介

([English](README.md)/**中文**)

LCUI CLI 是一个能帮助你快速开发 LCUI 应用程序的工具，提供：

- 项目脚手架。
- 类似于 Webpack 的编译器，基于多种加载器：
  - ts-loader：加载 JavaScript、TypeScript 文件，支持 JSX 语法。你可以像编写 React 组件一样编写 LCUI 部件。
  - css-loader：加载 CSS 文件，支持 CSS Modules 写法。
  - sass-loader： 加载 Sass/SCSS 文件并将其编译为 CSS。
  - json-loader：加载 JSON 文件，允许你以 JSON 格式描述界面。
  - xml-loader：加载 XML 文件，允许你以 XML 格式描述界面。
  - yaml-loader：加载 YAML 文件，允许你以 YAML 格式描述界面。

LCUI CLI 致力于将 LCUI 生态中的工具基础标准化。

## 安装

在安装这个工具之前，你需要在你的计算机上安装这些依赖:

- [Git](https://git-scm.com)
- [Node.js](https://nodejs.org/en/download/) (自带 [npm](http://npmjs.com))
- [XMake](https://xmake.io/)

之后，运行：

``` bash
npm install -g @lcui/cli
# 或者
yarn global add @lcui/cli
```

## 使用

创建一个 LCUI 应用程序项目：

```bash
lcui create my-project
```

编译 app 目录内的所有文件：

```bash
lcui build
```

编译单个文件：

```bash
lcui build app/page.tsx
```

## 许可

[MIT](LICENSE)