Despite the COVID-19 outbreak, our team continues operating at full speed. We are always here to support and answer all your questions.

Feel free to reach out by filling this quick form.

Fill the form
Get Free Trial
  1. API reference
  2. Welcome
    1. Component overview
    2. Get Flexmonster
    3. Quick start
    4. System requirements
    5. Troubleshooting
    6. Managing license keys
    7. Migrating from WebDataRocks to Flexmonster
  3. Integration with frameworks
    1. Available tutorials
    2. Integration with Angular
    3. Integration with React
    4. Integration with Vue
    5. Other integrations
      1. Integration with Python
        1. Integration with Django
        2. Integration with Jupyter Notebook
      2. Integration with React Native
      3. Integration with AngularJS (v1.x)
      4. Integration with TypeScript
      5. Integration with R Shiny
      6. Integration with jQuery
      7. Integration with Ionic
      8. Integration with Electron.js
      9. Integration with Webpack
      10. Integration with RequireJS
  4. Connecting to Data Source
    1. Supported data sources
    2. JSON
      1. Connecting to JSON
      2. Connecting to JSON using Flexmonster Data Server
      3. Data types in JSON
    3. CSV
      1. Connecting to CSV
      2. Connecting to CSV using Flexmonster Data Server
      3. Data types in CSV
    4. Database
      1. Connecting to SQL databases
      2. Connecting to a MySQL database
      3. Connecting to a Microsoft SQL Server database
      4. Connecting to a PostgreSQL database
      5. Connecting to an Oracle database
      6. Connecting to other databases
    5. Flexmonster Data Server
      1. Getting started with Flexmonster Data Server
      2. Installation guide
      3. Configurations reference
      4. Data sources guide
      5. Security and authorization guide
      6. The Data Server as a DLL
        1. Getting started with the Data Server as a DLL
        2. Referring the Data Server as a DLL
        3. Implementing the API controller
        4. Implementing the server filter
        5. Implementing the custom parser
        6. DLL configurations reference
        7. The controller's methods for request handling
    6. MongoDB
      1. Introduction to Flexmonster MongoDB Connector
      2. Getting started with the MongoDB Connector
      3. Embedding the MongoDB Connector into the server
    7. Microsoft Analysis Services
      1. Connecting to Microsoft Analysis Services
      2. Getting started with Flexmonster Accelerator
      3. Referring the Accelerator as a DLL
      4. Configuring the authentication process
      5. Configuring a secure HTTPS connection
      6. Troubleshooting
    8. Custom data source API
      1. Introduction to the custom data source API
      2. A quick overview of a sample Node.js server
      3. A quick overview of a sample .NET Core server
      4. Implement your own server
        1. Implementing the custom data source API server
        2. Implementing filters
        3. Supporting more aggregation functions
        4. Returning data for the drill-through view
    9. Elasticsearch
      1. Connecting to Elasticsearch
      2. Configuring the mapping
    10. Pentaho Mondrian
      1. Connecting to Pentaho Mondrian
      2. Getting started with the Accelerator
      3. Configuring Mondrian roles
      4. Configuring username/password protection
      5. Configuring a secure HTTPS connection
      6. Troubleshooting
  5. Security
    1. Security in Flexmonster
    2. Security aspects of connecting to an OLAP cube
      1. Ways of connecting to an OLAP cube
      2. The data transfer process
      3. Data security
      4. Data access management
  6. Configuring report
    1. What is a report
    2. Data source
    3. Slice
    4. Options
    5. Mapping
    6. Number formatting
    7. Conditional formatting
    8. Set the report for the component
    9. Get the report from the component
    10. Date and time formatting
    11. Configuring global options
    12. Export and print
    13. Calculated values
    14. Custom sorting
  7. Charts
    1. Available tutorials
    2. Flexmonster Pivot Charts
    3. Integration with Highcharts
    4. Integration with amCharts
    5. Integration with Google Charts
    6. Integration with FusionCharts
    7. Integration with any charting library
  8. Customizing
    1. Customizing the Toolbar
    2. Customizing appearance
    3. Customizing the context menu
    4. Customizing the grid
    5. Customizing the pivot charts
    6. Localizing the component
  9. Updating to the latest version
    1. Updating to the latest version
    2. Release notes
    3. Migration guide from 2.7 to 2.8
    4. Migration guide from 2.6 to 2.7
    5. Migration guide from 2.5 to 2.6
    6. Migration guide from 2.4 to 2.5
    7. Migration guide from 2.3 to 2.4
    8. Migration guide from 2.2 to 2.3
    9. Documentation for older versions
  10. Flexmonster CLI Reference
    1. Overview
    2. Troubleshooting the CLI
    3. flexmonster create
    4. flexmonster add
    5. flexmonster update
    6. flexmonster version
    7. flexmonster help
Table of contents

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

This guide contains the following sections:

  1. Flexmonster CLI installation 
  2. CLI command syntax
  3. Available commands
  4. Basic usage:
  5. Troubleshooting

Flexmonster CLI installation

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.

CLI command syntax

flexmonster command syntax:

flexmonster commandNameOrAlias requiredArg optionalArg [options]

For example:

flexmonster create react es6 --install

This command will create a simple React + ES6 project with Flexmonster and install 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
  • --install (or -i) — the option

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

Available commands

Flexmonster CLI has the following commands:

Command Alias Description
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
help h Provides help on the available commands and options

Basic usage

This section will help you get started with the CLI. If you have any issues when running the CLI commands, visit our troubleshooting page.

See Flexmonster CLI version

To see the CLI version, run the following command:

flexmonster version

Get help on commands

Get the list of all the available commands and options with the help command:

flexmonster help

To see the description, options, and usage examples for a particular CLI command, run the following command:

flexmonster commandNameOrAlias --help

Create a sample project with Flexmonster

To create and run a sample JavaScript project with Flexmonster, use the following CLI command:

flexmonster create javascript -r

The create command also allows setting up sample projects based on TypeScript or different front-end frameworks. See more details about the create command.

Add Flexmonster to a project

Install the flexmonster npm module with the add command. Run this command from the project folder containing package.json:

flexmonster add flexmonster

The add command can also download Flexmonster Data Server, Flexmonster Accelerator, or framework wrappers. Learn more about the add command in the documentation.

Update Flexmonster

Update Flexmonster Pivot with the update command:

flexmonster update 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.

Troubleshooting

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

See also

flexmonster create
flexmonster add
flexmonster update
flexmonster version
flexmonster help