Skip to content
Switch branches/tags


GitHub Actions codecov



LCUI CLI is command line interface for rapid LCUI development. providing:

  • Mininal LCUI project template
  • Generator for components and views
  • Internationalization (i18n)

Quick start

Before using this tool, you need install the following tools on your computer:

To install the new package, use one of the following commands. You need administrator privileges to execute these unless npm was installed on your system through a Node.js version manager (e.g. n or nvm).

npm install -g @lcui/cli
# OR
yarn global add @lcui/cli

Then run the following commands:

# Create a porject
lcui create my-project

# Enter the project directory
cd my-project

# set up the development environment for this project
lcui setup

# Build project
lcui build

# run project
lcui run

If you are ready to develop an LCUI application, you can try the following commands:

# Create a component (widget)
lcui generate widget MyWidget

# Create a view
lcui generate view MyView

# Create a internationalization (i18n) config file
lcui generate i18n

# Compile i18n config file to C code. (default compile config/i18n.js to src/lib/i18n.c and src/lib/i18n.h)
lcui compile i18n