Sasti-cli NPM | npm.io

Sasti CLI

Sasti is a templating tool to make Express applications using only the command line.

Installation

Use the package manager npm to install sasti-cli.

npm install sasti-cli

Setting Environment Variables

After successfully installing the sasti-cli library, it's important to configure your environment variables to enable seamless usage. Follow the steps below based on your operating system.

For macOS: Open your terminal and run the following command to set the environment variable. Replace cli-path with the actual path where you have installed sasti-cli.

export PATH="/<cli-path>:$PATH"

For a global installation, the path typically is:

export PATH="/usr/local/lib/node_modules/sasti-cli:$PATH"

For Windows and Linux users, set the environment variable appropriately using the method suitable for your platform.

Usage

It is a command line tool that you can use using your terminal.

sasti

CLI Options

Some of the parameters you can pass to the cli.

--path <path> Specify the path (replace with your desired path)
--path <path> (Specify the path replace with desired path where you want this app to be created, default is ./)
--name <name> (Specify the name of the project/app replace with the app name that you want to create/update, default expressApp)
--port <port> (Specify the port for your app replace with the actual port, default is 8080)
--module <module> (Specify module for your app if you want to create a module replace with the name of the module e.g user, customer, admin etc.)
--middleware <middleware> (Specify the middleware for your app if you want to create a middleware replace with actual middleware name)
--orm <orm> (Specify the orm you want to use in the application, replace with the name of the orm that you want to use.It can only be monogoose or type-orm)
--model <model> (Specify model name for your database model, replace with the name of your model e.g user, customer, admin etc)

Examples

sasti --port 8080

sasti --port 8080 --name express --module user

sasti --port 8080 --name express --module user --middleware auth --path ../

sasti --port 8080 --name express --module user --middleware auth --path ../ --orm mongoose --model user

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change Please make sure to update tests as appropriate.