🚀 Modern CLI Tool for Streamlined Development

This is a modern CLI tool designed to simplify the development process. With simple commands, you can quickly initialize projects, manage configurations, and execute common tasks.

🚀 Quick Start

This CLI tool can be installed globally, allowing you to use it from any directory.

npm install -g my-cli

After installation, you can invoke the tool using the command my-cli in any directory.

✨ Features

Global Installation: Install the tool globally using npm install -g my-cli and use it anywhere.
Project Initialization: Create a basic project structure and configure core dependencies with my-cli init.

📦 Installation

Basic Configuration

Install dependencies:

npm install

Initialize the database connection:

npm run db:init

Start the development server:

npm start

Environment Variable Management

It is recommended to use the .env file to manage environment configurations. Create a .env file and add the following content:

PORT=3000
DB_HOST=localhost
DB_PORT=5432

Then load these environment variables in config.js:

const config = {
  port: process.env.PORT || 3000,
  db: {
    host: process.env.DB_HOST,
    port: process.env.DB_PORT
  }
};

💻 Usage Examples

Basic Usage

Create a New Project

my-cli init --name my-new-project

This will create a new directory named my-new-project and initialize the project structure inside it.

Configure Custom Endpoints

Add custom routes in app.js:

const express = require('express');
const app = express();

app.get('/api/custom', (req, res) => {
  res.send({ message: 'Custom endpoint' });
});

app.listen(config.port, () => {
  console.log(`Server running on port ${config.port}`);
});

Execute Database Migrations

npm run db:migrate

⚠️ Important Notes

Dependency Management: Use package.json and yarn.lock to ensure that all project members use the same dependency versions.
Environment Isolation: Use different .env files for development and production environments to avoid configuration conflicts.
Code Style: Follow the project's code style guidelines, such as ESLint and Prettier.

🛠️ Integration with Other Tools

Type Checking:

npm run typecheck

Unit Testing:

npm test

🐞 Error Handling and Debugging

Common Issues

Installation Failure:
- Ensure that Node.js and npm are installed correctly.
- Check the network connection and avoid download failures due to mirror source issues.
Startup Error:
- Check the console output for specific error information.
- Ensure that all dependencies are installed correctly and check the configuration files.

Debugging Tips

Enable debug mode using the DEBUG environment variable:

DEBUG=my-cli npm start

🤝 Contributing

We welcome forks and pull requests! Before submitting code, please ensure that you pass the unit tests and follow the project's code style guidelines.