1.0.1 • Published 5 months ago
flow-server-cli v1.0.1
Flow Server CLI
A command-line tool for creating and managing Flow Server projects.
Features
- Create new Flow Server projects with a standard structure
- Initialize projects from npm templates like
flow-server-starter
orflow-server-zaza
- Generate plugins, engines, and services
- Manage configuration
- Interactive prompts for easy setup
Installation
# Install globally to make the 'flow-server' command available everywhere
npm install -g flow-server-cli
# After installation, you can run the CLI directly:
flow-server create my-project
Usage
Create a new project
flow-server create my-project
Initialize a project from a template
# Initialize from default flow-server-starter
flow-server init my-project
# Initialize from a specific template
flow-server init my-project flow-server-zaza
Generate a plugin
flow-server generate plugin my-plugin
Generate a service
flow-server generate service my-service
Project Structure
When creating a new project, the following structure is generated:
my-project/
├── config/
│ └── config.json
├── plugins/
├── services/
├── engines/
├── package.json
└── index.js
Configuration
The CLI uses a configuration file located at ~/.flow-server/config.json
. You can modify this file to change the default behavior of the CLI.
Links
License
MIT