https://github.com/kartikmehta8/km-engine-cli
A CLI tool that manages templates, allowing users to efficiently list, add, delete, and use templates, with progress tracking.
https://github.com/kartikmehta8/km-engine-cli
cli nodejs template-engine
Last synced: about 2 months ago
JSON representation
A CLI tool that manages templates, allowing users to efficiently list, add, delete, and use templates, with progress tracking.
- Host: GitHub
- URL: https://github.com/kartikmehta8/km-engine-cli
- Owner: kartikmehta8
- License: mit
- Created: 2024-10-03T17:43:17.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-10-03T17:46:00.000Z (8 months ago)
- Last Synced: 2025-03-28T03:58:43.374Z (about 2 months ago)
- Topics: cli, nodejs, template-engine
- Language: JavaScript
- Homepage:
- Size: 417 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# KM - A Template Engine CLI
A simple CLI tool to manage templates in your project. This CLI allows you to list, add, delete, and use templates seamlessly.
## Features
- List available templates.
- Add a new template (file or folder) with a name, description, and path.
- Delete an existing template by its name.
- Use a template by copying it to the current directory.
- Displays a progress bar for the template usage.
## Installation
1. Clone the repository:
```bash
git clone https://github.com/kartikmehta8/km-engine-cli.git
```
2. Navigate to the project directory:
```bash
cd km-engine-cli
```
3. Install the dependencies:
```bash
npm install
```
## Usage
### List Templates
To list all available templates with their descriptions, run:
```bash
node index.js list
```
**Example:**
### Add a Template
To add a new template, use the `add` command. It will prompt you to enter the template's name, description, and file/folder path.
```bash
node index.js add
```
**Example:**
### Delete a Template
To delete a template by its name, use the `delete` command:
```bash
node index.js delete
```
**Example:**
### Use a Template
To use a template by copying it to your current directory, run:
```bash
node index.js use
```
**Example:**
### Help Command
To view all available commands and descriptions, run:
```bash
node index.js help
```
**Example:**
## Project Structure
```bash
├── src
│ ├── commands # Contains all the CLI commands.
│ ├── config # Configuration files for paths, etc.
│ ├── utils # Utility functions used across the project.
│ └── templates.json # Stores all template metadata.
└── index.js # Main entry point for the CLI.
```