Express CLI Documentation

Installation

To use the Express CLI, you need to install it globally. Open your terminal and run the following command:

npm install -g @ifritzler/express-cli

Usage

After installing the CLI globally, you can run it using npx along with the following commands:

1. Initialize Project

Command

npx express-cli init

Description

This command initializes the project. It sets up the necessary configuration and folder structure.

2. Setup Database

Command

npx express-cli --setup-db

Description

This command sets up the database using Prisma. It ensures that the database is configured and ready for use.

3. Generate Route

Command

npx express-cli generate route

Alias

npx express-cli g route

Description

This command generates a new route. It executes the route generation script and creates the required files and folders for a new route.

Examples

Initialize Project

npx express-cli init

Setup Database

npx express-cli --setup-db

Generate Route

npx express-cli generate route

Generate Route (Alias)

npx express-cli g route

Note

• Ensure Node.js is installed on your machine.
• Run the CLI commands from the root directory of your project.

Feel free to explore and customize the CLI to suit your project's needs.