Flexmonster CLI is a command-line interface tool for Flexmonster.
The CLI can:
This guide contains the following sections:
To install Flexmonster CLI, you will need Node.js and npm. Get it here if it’s not already installed on your machine.
Then install Flexmonster CLI globally to use its commands on your computer:
npm install -g flexmonster-cli
Now a new
flexmonster command is available in the console. If needed, see troubleshooting.
flexmonster command syntax:
flexmonster commandNameOrAlias requiredArg optionalArg [options]
flexmonster create react es6 --install
This command creates a simple React + ES6 project with Flexmonster and installs all the npm dependencies. The command consists of the following parts:
flexmonster— the executable used to run all the CLI commands.
create— the command name.
react— the required argument.
es6— the required argument.
-i) — the option.
Option names have the
-- prefix (e.g.,
--install), and option aliases are prefixed with
-i). Command arguments are not prefixed (e.g.,
Flexmonster CLI has the following commands:
|create||c||Creates a sample project with Flexmonster based on a chosen language and framework|
|add||a||Downloads Flexmonster Pivot, framework wrappers, Flexmonster Data Server, Theme Builder, or Flexmonster Accelerator|
|update||u||Updates Flexmonster Pivot, framework wrappers, Flexmonster Data Server, or Flexmonster Accelerator|
|version||v||Outputs the Flexmonster CLI version and notifies about CLI updates if any.|
|help||h||Provides help on the available commands and options|
This section will help you get started with the CLI. If you have any issues when running the CLI commands, visit our troubleshooting page.
To see the CLI version, run the following command:
Get the list of all the available commands and options with the
To see the description, options, and usage examples for a particular CLI command, run the following command:
flexmonster commandNameOrAlias --help
The create command also allows setting up sample projects based on TypeScript or different front-end frameworks. See more details about the create command.
Install Flexmonster Pivot from npm with the
add command. Run this command from the project folder containing
flexmonster add js-flexmonster
add command can also download Flexmonster Data Server, Flexmonster Accelerator, or framework wrappers. Learn more about the
add command in the documentation.
Update Flexmonster Pivot with the
flexmonster update js-flexmonster
Framework wrappers and our additional tools (the Data Server and the Accelerator) can also be updated with the
update command. See the full description of this command.
If you have any issues when running the CLI commands, visit our troubleshooting page.
You may be interested in the following articles: