pzr is a CLI tool for generating project structures and files for Next.js, Express.js, and Vite React projects. It simplifies the process of creating new pages, routes, and components, allowing developers to focus on writing business logic rather than boilerplate code.

• Installation
• Usage
  • Initializing a Project
  • Generating Files
• Project-Specific Usage
• Configuration
• Support
• License

You can install pzr globally using npm or yarn:

npm install -g pzr
# or
yarn global add pzr

Note: Global installation allows you to use pzr from any directory on your system.

To initialize a new project or configure pzr for an existing project, run:

pzr init

This command will detect your project type and configuration and prompt you to confirm or modify the detected settings.

To generate new pages, routes, or components, use the create command or its shorthand -c:

pzr create [pages...]
# or
pzr -c [pages...]

Example:

pzr create home about contact
# or
pzr -c home about contact

This will create new pages/routes for "home", "about", and "contact" based on your project configuration.

To generate files in a specific directory, use the -d or --directory option:

pzr create -d dashboard/settings profile
# or
pzr -c -d dashboard/settings profile

This will create a "profile" page/route inside the "dashboard/settings" directory.

Tip: You can create multiple pages/routes at once by listing them after the create command or -c flag.

If you prefer not to install pzr globally, you can use it on a per-project basis:

1. Install as a dev dependency:

   npm install --save-dev pzr
   # or
   yarn add --dev pzr

2. Run pzr commands using npx:

   npx pzr init
   npx pzr -c home about

3. Alternatively, add scripts to your package.json:

   {
     "scripts": {
       "pzr:init": "pzr init",
       "pzr:create": "pzr -c"
     }
   }

   Then use npm or yarn to run the commands:

   npm run pzr:init
   npm run pzr:create home about
   # or with yarn
   yarn pzr:init
   yarn pzr:create home about

You can also use pzr without installation via npx:

npx pzr init
npx pzr -c home about
npx pzr -c -d dashboard/settings profile

Note: Using npx without installation may result in slower execution times as it downloads the package each time.

pzr stores its configuration in a .pzr-config.json file in your project root. This file is created when you run pzr init and contains information about your project type, language preference, and other settings.

Warning: It's recommended to use the pzr init command to modify your configuration. Manual edits to .pzr-config.json may lead to unexpected behavior.

For bug reports and feature requests, please open an issue on our GitHub repository.

Info: Contributions are welcome! Feel free to submit pull requests to help improve pzr.

pzr is released under the MIT License. See the LICENSE file for more details.