API.md

Global

---

Class: CLI

.prettyError: PrettyError , Instance of https://github.com/AriaMinaei/pretty-error . .argv: object , Parsed result of https://github.com/substack/minimist . .color: Chalk , Instance of https://github.com/chalk/chalk . .Error: CLI.Error , Constructor to create a new instance of custom n-cli Error . .minimist: Minimist , Instance of https://github.com/substack/minimist . .config: user-appdata , Instance of user-appdata https://github.com/s-a/user-appdata

CLI.resolvePath(fileOrDir)

Resolve a path

Parameters

fileOrDir: string, Filename or directory

Returns: string, Absolute directory name relative to the current working directory of process.

CLI.showHelp()

Output help to console. The ncli tries to find help.txt in your project folder and outputs it to console.

CLI.showVersion()

Output version to console.

CLI.findup(basedir, filename, json)

Find a file in parent directories.

Parameters

basedir: string, In most cases the current directory of process.

filename: string, Filename to find.

json: boolean, parse text to JSON object if true.

Returns: string, Absolute directory to given filename.

CLI.programInfo()

Output program information based on package.json to console.

CLI.on(commandName, commandFunction)

Catch a commandline switch case. The commandFunction runs in context of CLI.

Parameters

commandName: string, A command you want to process. For example push or commit.

commandFunction: function, event handler function in context of CLI.

CLI.runcom(commandFunction)

Executes if a runcom file was found.

Parameters

commandFunction: function, Event handler function.

Example:

var cli = new CLI({runcom:".nclirc", handleUncaughtException:true, silent:false });
cli.runcom(function(rc){
  console.log(rc);
});
// yields -> 
// { 
//   dir: 'c:\\git\\n-cli',
//   filename: '.nclirc',
//   fullpath: 'c:\\git\\n-cli\\.nclirc',
//   settings: contents-of-rc-file
// }

CLI.silent()

Determines if console app is running in silent mode. Silent mode activates automaticaly when process.env.NODE_ENV === "test".

CLI.log()

Like console.log put implements util.inspect.

CLI.error()

Like console.error put implements util.inspect.

CLI.stdout()

Wrapper for process.stdout.write

CLI.stderr()

Wrapper for process.stderr.write

---