Welcome to the official repo of sl-cli

Installation

• sudo npm i -g @servicelabsco/slabs-dev-cli

Add ENV file in the working dir

• After you install the cli, you are required to add some configuration in the .env file. Please add Key: cli_password and Value: 123456. this is the basic authentication for accessing the cli

sl-cli

This Command Line Interface (CLI) tool, referred to as "sl-cli," is provided as an open-source project under the MIT License. By using or contributing to this project, you acknowledge and agree to the terms and conditions of the license.

Help

• Command: sl help
• Description: This command is responsible for listing down all the command that is supported in this cli.

Generator (Add the Feature)

• Command: sl generator
• Description: This command is responsible for generating the listing and controllers along with the migration file. It can be used to create features within the module. this allows you to create the direct controllers, migration, job, subscriber and listing

Seeder (Add Data to the table)

• Command: sl seeder
• Description: This command is responsible to create the seeder for adding any data to the table

Sync Classes (Sync The file)

• Command: sl syncClasses
• Description: This command is responsible to sync all the jobs file, create entity hash that can be use as a source definition. Moreover this will also add the necessary files in the es6Classes

migrator

• Command: sl migrator
• Description: This command is responsible to create the migration file which will allow you to create the migration in the postgres table.

Warnings

1. Use at Your Own Risk: This CLI tool is provided "as-is," and the author makes no guarantees or warranties regarding its functionality, accuracy, or suitability for any purpose. Usage of this tool is at your own risk.

2. Backup Critical Data: Before using any commands that modify data or settings, it is strongly recommended to create backups of critical data to prevent unintentional loss or corruption.

Contribution

Contributions to this project are welcome. However, please adhere to the guidelines outlined in the CONTRIBUTING.md file.

License

This project is licensed under the MIT License.

For more information, visit the GitHub repository.

Thank you for using sl-cli!