create-imbrace-app

A CLI tool to quickly scaffold a new project from a boilerplate repository.

Installation

Global Installation (Recommended)

Install the package globally via npm:

npm install -g create-imbrace-app

After installation, you can use the CLI command anywhere:

create-imbrace-app my-project

Using npx (No Installation Required)

You can run the tool directly without installing it:

npx create-imbrace-app my-project

Usage

Basic Usage

create-imbrace-app [projectName]

If you don't provide a project name, the CLI will prompt you for one.

Interactive Mode

Simply run the command without arguments:

create-imbrace-app

You'll be prompted to:

1. Enter your project name
2. Choose whether to install dependencies automatically

Command Options

| Option | Description | Default | |--------|-------------|---------| | [projectName] | Name of your project directory | Prompts if not provided | | --repo <url> | Custom git repository URL to clone from | https://github.com/kelvin-nguyen-1/boilerplate | | --no-install | Skip automatic dependency installation | Dependencies are installed by default | | -h, --help | Display help information | - |

Examples

Create a project with default settings

create-imbrace-app my-awesome-app

Create a project from a custom repository

create-imbrace-app my-app --repo https://github.com/username/my-boilerplate

Create a project without installing dependencies

create-imbrace-app my-app --no-install

Then install dependencies manually later:

cd my-app
npm install

What It Does

When you run the command, the tool will:

1. Clone the repository - Downloads the boilerplate from the specified git repository (main branch)
2. Clean up - Removes .git, dist, and build directories from the cloned project
3. Install dependencies (optional) - Runs npm install --legacy-peer-deps if you choose to install
4. Display next steps - Shows you commands to get started with your new project

After Creation

Once your project is created, navigate to the directory and start developing:

cd my-project
npm run dev

Requirements

• Node.js (v14 or higher recommended)
• Git (for cloning repositories)
• npm or npx

Development

To work on this tool locally:

1. Clone this repository
2. Install dependencies: npm install
3. Link the package locally: npm link
4. Test the command: create-imbrace-app test-project

License

ISC