{"id":19902095,"url":"https://github.com/execrc/pzr","last_synced_at":"2026-01-17T15:56:03.356Z","repository":{"id":256349095,"uuid":"855004071","full_name":"sujit-shrc/pzr","owner":"sujit-shrc","description":"A CLI tool for generating Next.js, Express.js, and Vite React project templates","archived":false,"fork":false,"pushed_at":"2024-09-11T14:24:04.000Z","size":61,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-09T13:46:29.478Z","etag":null,"topics":["cli","expressjs","hacktoberfest","hacktoberfest-accepted","hacktoberfest2024","javascript","nextjs","template-generator","typescript","vite-react"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/pzr","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sujit-shrc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-09-10T06:17:37.000Z","updated_at":"2024-09-29T06:48:44.000Z","dependencies_parsed_at":"2024-09-10T08:48:30.107Z","dependency_job_id":"90b086c3-ceef-4562-9970-5df7c3c94265","html_url":"https://github.com/sujit-shrc/pzr","commit_stats":null,"previous_names":["sujit-shrc/pzr"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/sujit-shrc/pzr","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sujit-shrc%2Fpzr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sujit-shrc%2Fpzr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sujit-shrc%2Fpzr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sujit-shrc%2Fpzr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sujit-shrc","download_url":"https://codeload.github.com/sujit-shrc/pzr/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sujit-shrc%2Fpzr/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279002053,"owners_count":26083286,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","expressjs","hacktoberfest","hacktoberfest-accepted","hacktoberfest2024","javascript","nextjs","template-generator","typescript","vite-react"],"created_at":"2024-11-12T20:17:09.132Z","updated_at":"2026-01-17T15:56:03.269Z","avatar_url":"https://github.com/sujit-shrc.png","language":"TypeScript","readme":"# pzr (pazer) CLI\n\n\u003e [!NOTE]\n\u003e \n\u003e Supercharge your web development workflow with pzr - the CLI based templates generator tool for Next.js, Express.js, and Vite React projects!\n\npzr simplifies the process of creating new pages, routes, and components, allowing developers to focus on writing business logic rather than boilerplate code.\n\n## Why `pzr`?\n\n- 🔮 **Smart Project Config Detection**: Automatically identifies your project type and configuration\n- ⚡ **Lightning-Fast Setup**: Initialize new projects or add pzr to existing ones with a single command\n- 🏗️ **Effortless Scaffolding**: Generate pages, routes, and components tailored to your project structure\n- 🔧 **Flexible and Customizable**: Easily adjust detected settings to match your specific needs\n- 🌟 **Framework Agnostic**: Supports Next.js, Express.js, and Vite React out of the box\n\nWhether you're a seasoned developer or just starting out, pzr helps you focus on what matters most - writing great code and building amazing applications!\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Usage](#usage)\n  - [Initializing a Project](#initializing-a-project)\n  - [Generating Files](#generating-files)\n- [Project-Specific Usage](#project-specific-usage)\n- [Features](#features)\n- [Configuration](#configuration)\n- [Support](#support)\n- [License](#license)\n\n## Installation\n\nInstall `pzr` globally using `npm` or `yarn`:\n\n```bash\nnpm install -g pzr\n# or\nyarn global add pzr\n```\n\n\u003e [!TIP]\n\u003e \n\u003e Global installation allows you to use `pzr` from any directory on your system.\n\n## Usage\n\n### Initializing a Project\n\nTo initialize a new project or configure pzr for an existing project:\n\n```bash\npzr init\n```\n\nThis command will:\n\n1. 🔍 Automatically detect your project type and configuration\n2. 🖥️ Display the detected settings\n3. ✅ Prompt you to confirm or modify these settings\n\n### Generating Files\n\nCreate new pages, routes, or components using the `create` command or its shorthand `-c`:\n\n```bash\npzr create [pages...]\n# or\npzr -c [pages...]\n```\n\n#### Examples\n\nCreate multiple pages:\n\n```bash\npzr create home about contact\n# or\npzr -c home about contact\n```\n\nGenerate files in a specific directory:\n\n```bash\npzr create -d dashboard/settings profile\n# or\npzr -c -d dashboard/settings profile\n```\n\n\u003e [!TIP]\n\u003e \n\u003e You can create multiple pages/routes at once by listing them after the `create` command or `-c` flag.\n\n## Project-Specific Usage\n\n### Local Installation\n\nIf you prefer not to install `pzr` globally, use it on a per-project basis:\n\n1. Install as a dev dependency:\n\n   ```bash\n   npm install --save-dev pzr\n   # or\n   yarn add --dev pzr\n   ```\n\n2. Run `pzr` commands using `npx`:\n\n   ```bash\n   npx pzr init\n   npx pzr -c home about\n   ```\n\n3. Alternatively, add scripts to your `package.json`:\n\n   ```json\n   {\n     \"scripts\": {\n       \"pzr:init\": \"pzr init\",\n       \"pzr:create\": \"pzr -c\"\n     }\n   }\n   ```\n\n   Then use `npm` or yarn to run the commands:\n\n   ```bash\n   npm run pzr:init\n   npm run pzr:create home about\n   # or with yarn\n   yarn pzr:init\n   yarn pzr:create home about\n   ```\n\n### Via `npx` (without installation)\n\nUse `pzr` without installation via npx:\n\n```bash\nnpx pzr init\nnpx pzr -c home about\nnpx pzr -c -d dashboard/settings profile\n```\n\n\u003e [!WARNING]\n\u003e \n\u003e Using `npx` without installation may result in slower execution times as it downloads the package each time.\n\n## Features\n\n### 🔍 Automatic Project Configuration Detection\n\n`pzr` intelligently detects:\n\n- **Project Type**: Next.js, Express.js, or Vite React\n- **Language**: TypeScript or JavaScript\n- **Source Directory**: Whether you're using a `src` directory\n- **Next.js Routing**: Page Router or App Router (for Next.js projects)\n\n### 🖥️ User Confirmation Prompts\n\nAfter detection, `pzr` will display the detected settings and prompt you to confirm or customize them, ensuring accuracy and flexibility.\n\n### 📁 Project-Specific File Generation\n\n`pzr` file generation based on the project type:\n\n- **Next.js**:\n\n  - Generates `layout.tsx`, `page.tsx`, and `loader.tsx` in created routes in `/app` or `/src/app` dir.\n  - Supports both Page Router and App Router structures and both `tsx` and `jsx` components.\n\n- **Express.js**:\n\n  - Creates models, controllers, and routes for `js` or `ts` apps.\n  - Automatically adds `app.use(routeMiddleware)` in `app.ts`\n\n- **Vite React**:\n  - Generates `.jsx` or `.tsx` components in the `/components` directory\n\n\u003e [!IMPORTANT]\n\u003e \n\u003e We're actively working on adding support for more project types!\n\n## Configuration\n\npzr 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.\n\n\u003e [!CAUTION]\n\u003e \n\u003e It's recommended to use the `pzr init` command to modify your configuration. Manual edits to `.pzr-config.json` may lead to unexpected behavior.\n\n## Support\n\nFor bug reports and feature requests, please open an issue on our [GitHub repository](https://github.com/sujit-shrc/pzr).\n\n\u003e [!IMPORTANT]\n\u003e \n\u003e 🤝 We welcome contributions! Feel free to submit pull requests to help improve pzr.\n\n## License\n\n`pzr` is released under the MIT License. See the LICENSE file for more details.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexecrc%2Fpzr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fexecrc%2Fpzr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexecrc%2Fpzr/lists"}