MKS CLI
mks is a command-line interface (CLI) tool that helps you generate basic application structures with different features. It allows you to quickly set up application projects by creating the necessary files and directories based on your requirements.
Installation
To install mks, you need to have Go installed on your system. Then, run the following command:
go install github.com/unknowns24/mks@latest
Usage
Build an Application
To create a basic application structure, use the build
command:
mks build [name] --features=[features]
name
: The name of the application to be generated.
features
: (Optional) Generate application with features.
Example:
mks build ms_apps --features="mysql,jwt"
Add a Feature
To add a specific feature to an existing application, use the add
command:
mks add [feature]
feature
: The feature you want to add.
Example:
mks add mysql
Install a Template
To install a specific template to mks command database, use the install
command:
mks install [template]
template
: The template you want to add.
Example:
mks install cron
Features
mks supports the following features:
- MySQL Database (mysql)
- gRPC Client (grpc-client)
- gRPC Server (grpc-server)
- RabbitMQ Producer (rmq-producer)
- RabbitMQ Consumer (rmq-consumer)
- Jason Web Token Auth (jwt)
- All features (all) # Only on 'build' command
Templates
If you want to create a template, this are the requirements of the file structure that the template requires to works fine. Template should be a .zip file and installed with mks install command.
License
This project is licensed under the MIT License.
Contributing
Contributions are welcome! If you find any issues or would like to add new features, feel free to open an issue or submit a pull request on the GitHub repository: https://github.com/unknowns24/mks.
Authors