Generator

The Flowcore CLI generator is a tool that allows you to generate Flowcore applications, entities and more.

Generate a new Flowcore NextJS application

To generate a new Flowcore NextJS application, run the following command:

flowcore new nextjs-app <app-name>

this will scaffold a new NextJS application that is built using the Flowcore IDD approach and ready to use for the Flowcore Platform.

Information

This will generate a new directory with the name of the application. Inside the application directory, you will find a new NextJS application that is ready to use for the Flowcore Platform.

Generate a new Flowcore NextJS Entity

To generate a new Flowcore NextJS entity, run the following command:

flowcore generate nextjs-entity <entity-name>

Information

This needs to be run from inside a Flowcore NextJS application.

Generate a new Bun service

To generate a new Bun service, run the following command:

flowcore new bun-service <service-name>

Information

This will generate a new directory with the name of the service. Inside the service directory, you will find a new Bun application that is ready to use for the Flowcore Platform.

Generate a new Flowcore Bun Transformer

To generate a new Flowcore Bun Transformer, run the following command:

flowcore new transformer <transformer-name>

Information

This will create a new Transformer written in Bun, when deploying this on the Flowcore Platform. In order to use this Transformer, you need to add these parameters to the scenario YAML manifest.

scenario:
  transformers:
    <transformer-name>:
      # ...other parameters
      shell: flowcoreio/adapter-nodejs-transformer-shell:2.7.4-bun
      blueprint:
        entrypoint: index.js
        runtime: bun
      # ...other parameters

Generate a new Template Generator written using Bun

To generate a new Template Generator written in Bun, run the following command:

flowcore new generator <generator-name>

Information

This will generate a new directory with the name of the generator. Inside the generator directory, you will find a new Yeoman generator that can be written in Bun.

Generate a new Oclif Plugin for the Flowcore CLI

To generate a new Oclif Plugin for the Flowcore CLI, run the following command:

flowcore new plugin <plugin-name>

Information

This will generate a new directory with the name of the plugin. Inside the plugin directory, you will find a new Oclif plugin that can be used to extend the Flowcore CLI.