devkit-pro-cli
v1.0.0
Published
A developer productivity CLI for project setup, code generation and project health checks
Maintainers
Readme
DevKit Pro CLI
A professional developer productivity CLI tool that helps you initialize projects, generate boilerplate code, check project health, validate environment variables, clean unused code, and generate useful development reports.
Features
- Project Initialization: Scaffolds Node.js API, React, or Full Stack projects.
- Project Health Checks: Detects unused dependencies, missing dependencies, console logs, TODO comments, hardcoded secrets, large files, and more.
- Environment Validation: Validates
.envvariables against.env.example. - API Boilerplate Generation: Generates Controller, Route, Service, and Model files for an Express API.
- Component Generation: Generates React
.jsxor.tsxcomponents. - Project Cleanup: Interactively cleans temporary, log, and OS-generated files.
- Environment Doctor: Checks your development environment (Node.js, npm, Git, etc.).
Installation
```bash npm install -g devkit-pro-cli ```
Usage
```bash devkit [options] ```
Commands
| Command | Description | |---|---| | `devkit init` | Create a new project interactively | | `devkit check` | Analyze project health (dependencies, security, code quality) | | `devkit api ` | Generate CRUD API boilerplate (controller, route, service, model) | | `devkit component ` | Generate a React component (.jsx or .tsx) | | `devkit env` | Validate environment variables (.env vs .env.example) | | `devkit clean` | Clean unnecessary files with confirmation | | `devkit doctor` | Check development environment (Node, npm, Git, project files) | | `devkit report` | Generate a comprehensive project health report |
Examples
Initialize a project: ```bash devkit init ```
Check project health: ```bash devkit check ```
Generate a React component: ```bash devkit component Navbar --typescript ```
Generate an API resource: ```bash devkit api user ```
View Doctor report: ```bash devkit doctor ```
Configuration
You can configure the CLI using a `.devkitrc.json` file in the root of your project:
```json { "language": "javascript", "componentExtension": "jsx", "apiDirectory": "src", "componentsDirectory": "src/components" } ```
Development
Clone the repository and install dependencies:
```bash git clone https://github.com/yourusername/devkit-pro-cli.git cd devkit-pro-cli npm install npm link ```
Testing
```bash npm test ```
License
MIT License
