CLI for building with JSQL

Find out how to use JSQL CLI for building and watching files changes

Stack requirements

The JSQL CLI plugin will not work without an account in the JSQL cloud. To learn more see overview.

Of course, to use the CLI you need JavaScript project created.


Install JSQL CLI  globally into your system using NPM:

npm install -g npm-jsql

Once the CLI has been installed, it may be available inside bash/cmd console:



The CLI requires an API_KEY and src as a directory or input file and dist as the output directory:


Example invoke:

npm-jsql ==iSqF8rKvVeSgqudKDOXGMJh1PbeouIz9IW/YQ==9CI8ox66gogpoSXm6yr src/app.js dist true

List of configuration parameters:

API_KEY(String): your working application key from JSQL Admin Panel. See FAQ for details

SRC(String): file or input directory with files that will be processed


src: 'app.js'
src: 'src'
src: 'src/*.js'
src: 'src/app.js'

DIST(String): output directory where processed files will be saved


dist: 'output'
dist: 'build'

WATCHER(String): (Optional, default: false) Set to true to enable files changes observation and invoking JSQL after any files changes. Set nothing or false to disable (by default).

Developer key

The plugin requires the file with the developer key which must be found in the directory in which Gruntfile is.

This file can be downloaded from the JSQL Admin Panel by each team member (see how to download it in FAQ ) and saved locally in the project.

We recommend that the file with the development key be added to the ignored files with the repository used (GIT, SVN etc).


Type –help to get information about the input parameters

Errors handling

In case of any errors the information will be shown in red in standard output (console).

Detailed information will be added to debug/jsql-debug-[timeStamp].txt file.

What next?

Close Menu