We have changed our pricing. Flexmonster Software License Agreement was also updated (list of changes)
All documentation
  • Introduction
  • Connecting to data source
  • Browser compatibility
  • Documentation for older versions
  • Overview

    Flexmonster CLI is a command-line interface tool for Flexmonster. The CLI can:

    • Download Flexmonster Pivot or its framework wrappers.
    • Create sample projects with Flexmonster.
    • Get Flexmonster Data Server or Flexmonster Accelerator.
    • Update all of the above.

    Prerequisites

    Installation

    Install Flexmonster CLI globally using the following command:

    npm install -g flexmonster-cli

    Now the flexmonster command is available in the console.

    If you encounter any errors, see troubleshooting.

    CLI command syntax

    The flexmonster command syntax is the following:

    flexmonster { create | add | update | version | help } [args] [options]

    Check out an example:

    flexmonster create react es6 --run

    This command creates and runs a sample React + ES6 project with Flexmonster. The command consists of the following:

    • flexmonster — the executable used to run all the CLI commands.
    • create — the command name. See the list of available commands.
    • react — the first argument. Each command has its own list of arguments.
    • es6 — the second argument.
    • --run (or -r) — the option. Each command has its own list of options.

    Option names have the -- prefix (e.g., --run), and option aliases are prefixed with - (e.g., -r). Command arguments are not prefixed (e.g., react).

    Available commands

    CommandAliasDescription
    createcCreates a sample project with Flexmonster based on a chosen language and framework.
    addaDownloads Flexmonster Pivot, its framework wrappers, Flexmonster Data Server, theme builder, or Flexmonster Accelerator.
    updateuUpdates Flexmonster Pivot, its framework wrappers, Flexmonster Data Server, or Flexmonster Accelerator.
    versionvOutputs the Flexmonster CLI version and notifies about CLI updates (if any).
    helphProvides help on the available commands and options.

    Troubleshooting

    If you have any issues when running the CLI commands, visit our troubleshooting page.

    See also