fh-serverless/README.md

A Node.js CLI for optimizing and generating configuration files for Serverless projects

# fh-serverless

**fh-serverless** is a Node CLI package that allows you to optimize and generate configuration files for Serverless projects.

### Installation
To use **fh-serverless**, you must have Node.js installed on your machine. To install the package, run the following command:

```bash
npm install -g fh-serverless
```

## Available Commands

### **generate**

The **generate** command creates the serverless.yml configuration file.

```bash
fh-serverless generate <path>
```

**Available options:**

- -s, --script-folder <folder>: Specifies the path to the script folder.
- -e, --extensions <extensions...>: Specifies the format of the lambdas without the = attribute and separated by space.

## How to configure a project

### Project Structure
To use fh-serverless, your project must contain a mandatory scripts folder. If the scripts folder is not in the root directory of your project, you can specify the folder path when calling the commands.

### Mandatory project.json File
Your project must contain a mandatory project.json file. This file is responsible for storing the default configurations for your serverless.yml file.

### Adding Global Function Configurations
You can add a globalFunctionsConfig property to your project.json file. Any attributes added within this property will also appear within each function in the functions attribute of your serverless.yml file.