CHANGELOG.md

v2.1.1 (May 15, 2025)

• fix: Removed a log statement that is logging a undefined field.

v2.1.0 (May 1, 2025)

• fix: Fix for loading ESM - node.js upgrade on axway-cli and ESM conversion.

v2.0.2 (Jul 7, 2022)

• fix: Load extension subcommands, then re-register them by name and alias.

v2.0.1 (Jul 6, 2022)

• fix: Added missing src directory to distribution. Oops.

v2.0.0 (Jul 6, 2022)

• BREAKING CHANGE: Require Node.js 14.15.0 LTS or newer.
• BREAKING CHANGE: Changed package to a ES module.
• BREAKING CHANGE: Removed server mode including CLI.connect(), CLI.listen(), and CLI.schema().
• BREAKING CHANGE: No longer re-export pkg-dir.
• BREAKING CHANGE: generateHelp() now returns a promise.
• chore: Updated dependencies.

v1.16.0 (Apr 21, 2022)

• feat: Add support for extension CLIs with multiple exported entrypoints that do not use cli-kit. Fixes #97.
• chore: Updated dependencies.

v1.15.0 (Apr 10, 2022)

• feat: Moved internal banner value into state object to allow banner to be modified during command execution when autoHideBanner is enabled (default).
• chore: Updated dependencies.

v1.14.1 (Aug 23, 2021)

• fix: Fixed bug when adding a command using an absolute path to a js file.
• chore: Minor dependency updates.

v1.14.0 (Jul 27, 2021)

• feat: Added redact flag to arguments and options so advanced implementations can know if an argument/option may contain sensitive information. Redact flag is true by default, but can be set to false in the paramters or prefixing the name with a ~ such as "<~myoption>". Note that option flags (those without a value) default to false since the value is boolean.
• fix(cli): Added better error when failed to load extension on CLI construction.
• fix(help): Added error to exec state when help command is invoked with unknown command.
• fix(parser): Added argument reference to parsed argument.
• fix(parser): Fixed incomplete input for parsed "extra" arguments, commands, extensions, and arguments.
• style(help): Render warnings using yellow.
• chore: Updated dependencies.

v1.13.0 (Apr 26, 2021)

• feat(help): Added required options to usage on help screen.
• feat(ansi): Added trim(), trimStart(), and trimEnd() functions.
• fix(help): Pass styles as well as header and footer content when rendering help template on demand via help().
• fix(cli): Moved help parameter from Command to Context so that CLI can render custom help content.
• build: Improved watch task to not hang on a lint or build error.
• chore: Updated dev dependencies.

v1.12.0 (Apr 15, 2021)

• feat(extension): Allow extension exports values in its package.json to be the main path.
• fix(command): Fixed regression introduced when fixing the custom help content for extensions.

v1.11.4 (Apr 15, 2021)

• fix(command): Fixed custom help content for extensions.

v1.11.3 (Apr 14, 2021)

• fix(command): Only consider command name to be a file if it is an absolute path.

v1.11.2 (Apr 13, 2021)

• fix(cli): Set json flag on errors when the executing context or its parent contexts has a jsonMode flag set.
• chore: Updated dev dependencies.

v1.11.1 (Apr 8, 2021)

• fix: Don't override default value for boolean options.
• chore: Updated dev dependencies.

v1.11.0 (Mar 26, 2021)

• feat: Mix custom command, argument, option, and extension constructor parameters into each instance. Only works for non-existing properties.
• fix: Execute command actions using command's context.

v1.10.0 (Mar 25, 2021)

• feat(command): Support command name to be a path to command file.
• feat(extension): Added support for defining extension contexts.
• fix(option): Allow aliases to be negated.
• fix(argument): Use correct datatype property when transforming argument value.
• chore: Updated dependencies.

v1.9.3 (Jan 8, 2021)

• fix(extension): Strip the package scope name from an extension name, but still add it as a hidden alias.
• chore: Updated dependencies.

v1.9.2 (Jan 5, 2021)

• chore: Updated dependencies.

v1.9.1 (Nov 30, 2020)

• chore: Updated dependencies.

v1.9.0 (Nov 27, 2020)

• feat(extension): Added support actions.
• fix(terminal): One time keypress listener was not removing sigint handler after firing causing programs to appear hung.
• refactor(cli): Moved serverMode option from exec() to the constructor.
• style(help): Prefix the error with an 'x' symbol.
• chore: Updated dependencies.

v1.8.9 (Nov 15, 2020)

• fix(cli): Fixed bug where banner was rendered twice if autoHideBanner is enabled and an the executed command throws an error.

v1.8.8 (Nov 14, 2020)

• fix(cli): Force banner to be rendered on error.
• fix(cli): Render banner, but don't fire the banner hook on error.

v1.8.7 (Nov 14, 2020)

• fix(cli): Fixed banner hook from being fired more than once.

v1.8.6 (Nov 13, 2020)

• fix(cli): Fixed banner from being displayed more than once.

v1.8.5 (Nov 11, 2020)

• fix(extension): Removed node-pty support since it has never worked properly. On Windows, it would clear the screen and cause the parent to never exit. On macOS, it would not allow child processes to prompt for input.
• fix(extension): Switched non-cli-kit based extensions to be required()'d instead of spawned.
• chore: Updated dependencies.

v1.8.4 (Nov 10, 2020)

• fix(cli): Fixed rendering of banner if autoHideBanner is disabled.
• refactor(cli): Switched the banner event to a hook to allow banner event handlers to tie into the banner event before and after the banner is rendered.
• chore: Updated dependencies.

v1.8.3 (Nov 6, 2020)

• fix(cli): Unify arguments to the banner event handler.
• style(help): Align descriptions based on longest command, argument, and option label.
• style(help): Removed = between option label and value.
• chore: Updated dependencies.

v1.8.2 (Aug 26, 2020)

• fix(parser): Fixed bug where context tree rev change was not updating the local rev before re-parsing causing unnecessary nested re-parses.

v1.8.1 (Aug 26, 2020)

• fix(parser): Fixed bug where if the context tree changed, the last argument would never be re-parsed.

v1.8.0 (Aug 25, 2020)

• feat(parser): Added finalize event hook that is emitted before applying defaults and filling argv and _.
• feat(parser): Added data and parser to parse event payload and all argument and option callbacks.
• feat(parser): Fire argument and option callbacks for every argument and option across all contexts even if they're not discovered. This allows programs to dynamically resolve default values or alter the context tree.
• feat(command): Added callback parameter that is fired as soon as the parser finds the command.
• refactor(parser): Parser now extends a HookEmitter and is linked to the CLI instance to decouple the CLI from the Parser.
• refactor(parser): Moved default value initialization and populating argv and _ to end of parser chain so that option callbacks have the ability to modify the contexts and continue parsing.
• fix(keys): Fixed generateKey() to support multiple sequential escape sequences.
• chore: Updated dependencies.
• test(keys): Added unit tests for generateKey().

v1.7.0 (Aug 13, 2020)

• feat(ansi): Added ansi.split() to break a string up by ANSI escape sequences.
• feat(ansi): Added ansi.toLowerCase() and ansi.toUpperCase().
• chore: Updated dependencies.

v1.6.2 (Aug 11, 2020)

• fix(cli): Only show help on errors caused by parsing and validation, not command execution.

v1.6.1 (Aug 5, 2020)

• fix(cli): Fixed regression introduced in v1.6.0 that broke missing argument validation.
• fix(argument): Added missing argument callback and hint.
• chore: Updated dev dependencies.

v1.6.0 (Aug 3, 2020)

• feat(help): Added CLI instanced styles to help template rendering.
• fix(terminal): Only wire up keypress on stdin when added to Terminal and not if some other logic listens on stdin.
• fix(parser): Moved missing required argument validation from parser to CLI to allow option callbacks such as --version to work properly.
• chore: Updated dependencies.

v1.5.2 (Jul 24, 2020)

• fix(terminal): Fixed bug where keypress event listeners were not properly being wired up to stdin resulting in the listener not being removed after being fired once.

v1.5.1 (Jul 23, 2020)

• fix(context): Fixed circular reference introduced when fixing the generateHelp hook event in v1.3.0 when generated JSON object is stringified.

v1.5.0 (Jul 23, 2020)

• feat(cli): Added showHelp flag on thrown errors to override showHelpOnError. Defaults to true. This still requires help to be enabled.
• feat(debug): Added error style for help template and server mode error handling.
• fix(cli): Removed duplicate error logging when server mode execution throws exception.
• fix(help): Allow non-Error objects to be thrown and rendered on the help screen.
• chore(dep): Replaced fast-levenshtein with fastest-levenshtein.

v1.4.0 (Jul 21, 2020)

• feat(cli): Added support for user-defined in styles passed into the CLI constructor as well as the exec() method.
• feat(template): Added subheading style.
• fix(template): Properly escape tildes in templates with nested expressions.
• fix(help): Fixed option heading and subheading styling where the trailing : wasn't styled and whitespace was being trimmed.
• fix(help): Fixed option format to use proper required indicators.
• fix(cli): Fixed rendering of errors to debug log when server connection executes a command that throws an exception.

v1.3.0 (Jul 21, 2020)

• feat(cli): Added exec hook event.
• feat(context): Added ctx property to generateHelp hook event.
• fix(parser): Fixed bug in server mode where parse hook event was being omitted from the cloned context which is not accessible instead of the originating CLI instance.
• fix(cli): Fixed issue with server mode execution where a context would be deeply cloned, however Command and Extension objects were passed by reference.
• chore: Updated dependencies.

v1.2.4 (Jun 24, 2020)

• fix(cli): Server-side output streams extend TTY WriteStream to improve compatibility with packages that check isTTY and terminal helper functions such as cursorTo() and clearLine().
• chore: Updated dev dependencies.

v1.2.3 (Jun 19, 2020)

• feat(cli): Added timeout option to CLI.connect() with default of 5 seconds.
• fix(cli): CLI.connect() now waits for terminal resize handshake to complete before resolving.
• fix(cli): Set the remote terminal size on the stdout/stderr streams.

v1.2.2 (Jun 17, 2020)

• fix(cli): Fixed issue where extension banner was not overriding parent context's banner.
• fix(terminal): Fixed issue where banner was not being displayed if output occurred before banner callback was registered.

v1.2.1 (Jun 15, 2020)

• fix: Force all options after an extension is found to be an argument.
• fix: Sort commands and extensions alphabetically in the help output.
• chore: Updated dependencies.

v1.2.0 (Jun 3, 2020)

• feat(commands): Added syntactic sugar for declaring commands with aliases and arguments.
• feat(help): Added command aliases to the help screen.
• fix(cli): Dynamically resolve 'showHelpOnError'.
• fix(parser): Correctly resolve the parsed argument name in the debug logging.
• style(cli): Capitalized --version description.
• chore: Updated dev dependencies.

v1.1.1 (May 26, 2020)

• fix(cli): On error, print the error stack instead of the error object to prevent infinite loops when JSON stringifying error objects during error the printing.
• fix(cli): Improved server eval exit code handling.
• fix(help): Highlight format for missing options.
• chore: Updated dev dependencies.

v1.1.0 (May 15, 2020)

• feat(cli): Added new keypress ansi sequence for improved raw input handling in server mode.
• feat(cli): Added new exec ansi sequence to explicitly run a command and differentiate between running a command and stdin input.
• refactor(cli): Greating improved remote stdin handling in server mode enabling support for prompting.
• fix(cli): Fixed bug where client wasn't emitting the correct exit code.
• fix(context): Added CLI properties to context init so that help in server mode can render properly.
• fix(parser): Fixed bug where known options that are not flags and do not have values were not properly being defaulted to an empty string.
• fix(help): Trim the rendered help output to avoid excess whitespace.
• chore: Updated dependencies.

v1.0.1 (May 8, 2020)

• fix(cli): Added support for 'parentContextNames' when a remote CLI instance is unaware of the local CLI's parent hierarchy.
• fix(cli): Fixed bug where remote banner would not suppress local banner and end up rendering both.
• fix(cli): Added banner to CLI schema object.
• chore: Updated dependencies.

v1.0.0 (May 1, 2020)

• BREAKING CHANGE: Require Node.js 10 or newer.
• fix(cli): Fixed bug where --version callback would show version if next() returned a truthy value instead of true since this option is a flag.
• fix(parser): Fixed regression introduced in 24f5048 where parser context chains where processed one context at a time instead of chaining them all together.
• fix(cli): Run the default command if selected command does not have an action. Fixes #64.
• chore: Updated dependencies.