skaffold-cli

Welcome to the skaffold-cli! This command-line interface (CLI) allows you to quickly scaffold a project structure for your Node.js CLI application. It comes with a predefined project structure, including essential files and directories to kickstart your development.

Installation

To install skaffold-cli, use the following npm command:

npm install -g skaffold-cli

This will install the CLI globally on your system, making it accessible from anywhere in your terminal.

Usage

After installation, you can create a new CLI project by running the following command:

skaffold generate

The CLI will prompt you to enter the name of your new CLI. Once you provide a valid name, it will generate the project structure and files in the current working directory.

Project Structure

The generated project structure includes the following directories and files:

# <your-cli-name>/
|   |-- bin/
|   |   |-- <your-cli-name>           # Executable script (entry point for the CLI)
|   |
|   |-- lib/
|   |   |-- <your-cli-name>.js        # Main CLI logic and functionality
|   |
|   |-- commands/
|   |   |-- command1.js      # Module for command1
|   |   |-- command2.js      # Module for command2
|   |   |-- index.js         # Exported commands for easy integration
|   |
|   |-- templates/
|   |   |-- cli.ejs          # Template for generating CLI files
|   |
|   |-- test/
|   |   |-- command1.test.js # Unit tests for command1
|   |   |-- command2.test.js # Unit tests for command2
|   |
|   |-- .gitignore
|   |-- .editorconfig
|   |-- .npmignore
|   |-- .eslintignore
|   |-- .eslintrc.json
|   |-- .prettierrc
|   |-- package.json
|   |-- README.md

Feel free to explore and customize the generated project according to your specific requirements.

Additional Configuration

The generated project also includes additional configuration files:

• .gitignore: Specifies files and directories to be ignored by Git.
• .editorconfig: Defines coding styles for different editors.
• .npmignore: Specifies files and directories to be excluded when publishing to npm.
• .eslintignore: Specifies files and directories to be ignored by ESLint.
• .eslintrc.json: ESLint configuration file with recommended rules.
• .prettierrc: Prettier configuration for code formatting.

You can customize these configuration files based on your project needs.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Thank you for using skaffold-cli! Happy coding!