@ldk-cli/cli

ldk-cli

A CLI that can be extended arbitrarily.

• Manage Templates
• Extend with plugins

You can specify any online Git repository or a directory or local directory of the repository as a template, and ldk-cli will install and manage them. ldk-cli also provides a plugin system to extend CLI.

Installation

Recommend using pnpm.

pnpm install @ldk-cli/cli -g

npm:

npm install @ldk-cli/cli -g

yarn:

yarn global add @ldk-cli/cli

Check if the installation was successful.

ldk-cli -V

Usage

Create a project:

ldk-cli create <projectName>

# <projectName> can be a path relative to the current shell
ldk-cli create ./my-project

# Specify a template
ldk-cli create ./my-project -t https://github.com/Devil-Training-Camp/virtual-scroll-list-liudingkang.git

If you run ldk-cli create ./online-test6:

All options:

Usage: ldk-cli create [options] <projectName>

Create new project

Options:
  -t --template <templateUrl>  Install template
  -f --force                   Force overwrite when project is existed (default: false)
  -h, --help                   display help for command

Template

Add a template:

ldk-cli temp --add https://github.com/Devil-Training-Camp/virtual-scroll-list-liudingkang.git

# Specify branch
ldk-cli temp --add https://github.com/Devil-Training-Camp/ldk-cli#dev

# Specific directory
ldk-cli temp --add https://github.com/Devil-Training-Camp/ldk-cli?temp=packages/cli#main

# Simplify a URL
ldk-cli temp --add Devil-Training-Camp/ldk-cli?temp=packages/cli#dev

# Add local template
ldk-cli temp --add  D:\develop\vue3\ldk-cli\packages\cli

Online templates and local templates can be specified, and online templates will be automatically cached.

If you run ldk-cli temp --add https://github.com/Devil-Training-Camp/virtual-scroll-list-liudingkang.git:

The added template will be available for selection when executing the create command:

→ See templates for more details.

Plugin

You can add plugins to extend CLI, these are some official plugins currently supported:

Plugin	Description
@ldk-cli/cli-plugin-base	Vite and Typescript plugin for ldk-cli
@ldk-cli/cli-plugin-eslint	ESLint plugin for ldk-cli
@ldk-cli/cli-plugin-prettier	Prettier plugin for ldk-cli
@ldk-cli/cli-plugin-vue	Vue plugin with vite for ldk-cli
@ldk-cli/cli-plugin-router	Vue router plugin with vite for ldk-cli

→ See plugins for documentation to manage plugins. → See custom plugins for documentation to write plugins.