index.js (1182B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /** 22 * Command-line interface (CLI). 23 * 24 * @module @stdlib/cli/ctor 25 * 26 * @example 27 * var CLI = require( '@stdlib/cli/ctor' ); 28 * 29 * var opts = { 30 * 'pkg': require( './path/to/package.json' ), 31 * 'help': 'Usage: beep [options] <boop>', 32 * 'title': 'foo', 33 * 'updates': true, 34 * 'options': { 35 * 'boolean': [ 36 * 'help', 37 * 'version' 38 * ] 39 * } 40 * }; 41 * var cli = new CLI( opts ); 42 * // returns <CLI> 43 * 44 * cli.close(); 45 */ 46 47 // MODULES // 48 49 var CLI = require( './main.js' ); 50 51 52 // EXPORTS // 53 54 module.exports = CLI;