Docma CLI


Instead of programmatically executing the Docma builder, you can directly use the CLI from your console. Although the CLI does not provide all build configurations as command-line options; it still supports all of them via the -c option which you can set the configuration file's path to.

CLI Options

Option                             Parameter Description
-h --help Output CLI usage information.
-V --version Output the Docma version number.
-c --config <path> Docma JSON configuration file path. You can define all build options within this file. Any option (below) set via CLI will overwrite the value defined in this file.
-s --src <[name:]path> Source file path. To define multiple source files, this option can be used more than once. To group/name source files, prefix each source path with name:. e.g. -s a.js -s mylib:b.js -s mylib:c.js -s other:d.js
-d --dest <path> Output destination directory path. CAUTION: This directory will be emptied before the build. Make sure you set this to a correct path.
--web-logs (Debug) Enable logs in the browser console, for the generated SPA.
-v --verbose <path> (Debug) Output verbose logs to consoles.
--nomin (Debug) Disable minification for the generated SPA assets. (e.g. js, css files)
--jd-out (Debug) Output one or more [name.]jsdoc.json files that include documentation data for each (grouped) javascript source. name is the group name you give when you define the source files. This is useful for investigating the raw JSDoc output.
--debug Enable all debugging options.
Equivalent to: --web-logs -v --nomin --jd-out
-q --quite (Debug) Disable build logs for the Node console.

Note: If no debug options are set in the CLI arguments (such as --debug, -q, --nomin, --jd-out, -v, --web-logs); the bitwise debug value from the config file is used, if set.

Examples