https://github.com/anikghosh256/kitty-cli
CLI tool for creating kitty component.
https://github.com/anikghosh256/kitty-cli
cli collaborate command-line template-tool
Last synced: 6 months ago
JSON representation
CLI tool for creating kitty component.
- Host: GitHub
- URL: https://github.com/anikghosh256/kitty-cli
- Owner: anikghosh256
- License: mit
- Created: 2023-02-25T19:09:57.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-03-05T10:32:00.000Z (over 1 year ago)
- Last Synced: 2025-09-20T02:52:46.573Z (10 months ago)
- Topics: cli, collaborate, command-line, template-tool
- Language: JavaScript
- Homepage:
- Size: 91.8 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# @anikghosh256/kitty-cli
[](https://www.npmjs.com/package/@anikghosh256/kitty-cli) 
CLI tool for creating kitty component.
## Installation
```bash
npm install @anikghosh256/kitty-cli -g
```
## Usage
```bash
kitty-cli init
```
After running `init` command there will be a new directory called `kitty`. In this directory every folder is a module. Each module has a `config.json` file which contains the configuration for the module. For example you will find a folder named `example` which contains a `config.json` file and a `example.kitty` file. The `config.json` file contains the configuration for the module and the `example.kitty` file contains the template for the module.
## How to create a module
To create a module you have to run the following command:
```bash
kitty-cli create --name
```
You can also pass parameters to the command. For example:
```bash
kitty-cli create --name "userModule" --author "John Doe" --email "john@doe.com"
```
## How to create a module template
To create a module template you have to create new folder in kitty folder with module name. For example if you want to create a module named `example` you have to create a folder named `example` in the kitty folder. Then you have to create a `config.json` file in the `example` folder. The `config.json` file should contain the following:
```js
{
"outputExtension": "js",
"outputFile": "example.js", /** optional (also can written with variable Ex: "${time(now)}-${name}.js" **/
"sourceFile": "./example.kitty",
"dir": "./",
"inputs": {
"name": {},
"message": {
"default": "hi"
}
}
}
```
The `outputExtension` is the extension of the output file. The `sourceFile` is the path to the template file. The `dir` is the directory where the output file will be created. The `inputs` is an object which contains the inputs for the template. The key of the object is the name of the input and the value is an object which contains the default value of the input you can leave it empty if you don't want to set a default value.
Then you have to create a template file. The template file should have the same name as the `sourceFile` in the `config.json` file. For example if the `sourceFile` is `./example.kitty` the template file should be named `example.kitty`. The template file will contain your code and some variables. The variables will be replaced with the inputs you passed to the command. For example if you have a variable named `name` in your template file and you pass `John` as the value of the `name` variable the `name` variable in the template file will be replaced with `John`.
```js
// example.kitty
console.log('Hello ${name}');
```
```bash
kitty-cli create example --name "John"
```
The output will be:
```js
// John.js
console.log('Hello John');
```
Note: The `name` variable is a special variable. It will also be used to name the output file. If you don't pass the `name` variable to the command it will show an error.