@eljs/create
Version:
Create a project from a remote template.
99 lines (87 loc) • 1.73 kB
Markdown
# @eljs/create
Create a project from a remote template.
## Installation
```bash
$ npm i @eljs/create -g
```
## Usage
```bash
$ create <template> <project-name>
// or
$ npx @eljs/create <template> <project-name>
```
```bash
Usage: create [options] <template> <project-name>
Options:
-v, --version Output the current version
--cwd <cwd> Specify the working directory
-f, --force Overwrite target directory if it exists
-m, --merge Merge target directory if it exists
--no-install Skip install dependencies after create done
-h, --help display help for command
```
## Configuration
Create a **create.config.ts** file in the project root.
```ts
export interface Config {
/**
* Working directory
* @default process.cwd()
*/
cwd?: string
/**
* Local template path or remote template
*/
template?: string | Template
/**
* Whether overwrite target directory if it exists
* @default false
*/
force?: boolean
/**
* Whether merge target directory if it exists
* @default false
*/
merge?: boolean
/**
* Whether enable default prompts
* @default true
*/
defaultQuestions?: boolean
/**
* Whether initialize git after create done
* @default true
*/
gitInit?: boolean
/**
* Whether install dependencies after create done
* @default true
*/
install?: boolean
/**
* Preset definitions
*/
presets?: PluginDeclaration[]
/**
* Plugin definitions
*/
plugins?: PluginDeclaration[]
}
/**
* Remote Template
*/
export interface RemoteTemplate {
/**
* Template type
*/
type: 'npm' | 'git'
/**
* Template value
*/
value: string
/**
* Npm registry
*/
registry?: string
}
```