Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sxzz/create

Command-line for creating projects from templates.
https://github.com/sxzz/create

Last synced: 7 days ago
JSON representation

Command-line for creating projects from templates.

Host: GitHub
URL: https://github.com/sxzz/create
Owner: sxzz
License: mit
Created: 2022-09-05T09:47:53.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2025-01-06T03:10:27.000Z (21 days ago)
Last Synced: 2025-01-07T23:51:51.705Z (19 days ago)
Language: TypeScript
Homepage:
Size: 523 KB
Stars: 31
Watchers: 1
Forks: 10
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome - create - A command-line tool for creating a new project. (Developer Experience (DX))

README

# @sxzz/create [![npm](https://img.shields.io/npm/v/@sxzz/create.svg)](https://npmjs.com/package/@sxzz/create)

Command-line for creating projects from templates.

## Install

```bash
npm i -g @sxzz/create

# Or use [p]npx
npx @sxzz/create
```

## Usage

### Create a project

```bash
create [path]
# e.g: create hello-world
```

### Edit configuration

```bash
# edit the configuration via VSCode, Vim, or Zed.
create edit
```

### Use remote configuration

```bash
create from
# e.g: create from https://raw.githubusercontent.com/sxzz/create/main/example.yaml

# or for short
create from ///
# e.g: create from sxzz/create/main/example.yaml
```

## Configuration

Most formats of configuration are supported.
The configuration file is located in `$HOME/.config/create.config.[js,mjs,ts,mts,json,yml,yaml]`

[TypeScript Schema](https://github.com/sxzz/create/blob/main/src/types.ts)

URL format: `repo[/subpath][#ref]`. See [examples](https://github.com/unjs/giget#examples).

Run `create config` to modify config.

```yaml
git:
init: true # optional, defaults to true

templates:
- name: Library # must be unique
# color: '#008800' # optional
children:
- name: TypeScript
color: '#3178c6'
url: sxzz/node-lib-starter # remote URL or local path
- name: Web App
url: xxxxx
git:
init: false # overwrite global config
```

## Sponsors

## Credits

- [kecrily/create](https://github.com/kecrily/create) 💖

## License