@fast-project/cli

1. Installation

npm install -g @fast-project/cli

2. Available commands

fp init

This command will generate files based on the preset file. It useful when you want to start a new project.

fp init --preset example-preset.yml --output ./generated

How the example-preset.yml file looks like:

apps:
  - projectName: 'example-node-js'
    plugins:
      - git
      - name: node
        config:
          packageManger: yarn
      - typescript
      - docker
      - eslint
      - express

Preset properties:

• apps: list of apps to generate.
• projectName: name of the project, it will be used as a folder name.
• plugins: list of plugins to apply for the project. A plugin can be a string or an object. If it's a string, it will be used as a plugin name. If it's an object, it will be used as a plugin config. The plugin config is different for each plugin. Please check the plugin docs to see how to config it.

To see all this command options, run fp init --help.

fp gen

This command will generate files based on the template file. It useful when you want to generate files for an existing project.

To generate using a template file:

fp gen --template example-template.hbs

To generate using a directory containing template files:

fp gen --template ./templates 

Supported template syntax:

• handlebars
• ejs
• pug

To see all this command options, run fp gen --help.

fp integrate

This command will integrate a plugin into the project. It useful when you want to add a new plugin to an existing project.

fp integrate --plugin eslint

To see all this command options, run fp integrate --help.