How to add custom commands in cli C++ library?

Use the Menu::Insert method with free functions, std::function, or lambdas, as shown in the README examples. Parameters can be basic types, strings, or custom types by overloading std::istream::operator>>, and you can handle arbitrary parameters with std::vector .

cli vs GNU readline for interactive terminals?

cli is a C++ header-only library focused on hierarchical menus and async architecture, ideal for structured CLI tools like network equipment interfaces. GNU readline is a C library for line editing with broader support but less built-in menu management, so cli is better for complex menu-driven applications.

How to enable telnet server in cli?

Use BoostAsioScheduler or StandaloneAsioScheduler along with CliTelnetServer (e.g., BoostAsioCliTelnetServer), as detailed in the Async programming section. You need to link with asio or boost libraries and specify paths during compilation, such as using CMake with -DCLI_UseBoostAsio=ON.

Does cli support Windows command line?

Yes, cli is cross-platform and works on Windows, as indicated by the win CI badge in the README. Compilation can be done with Visual Studio, nmake files, or CMake, ensuring consistent behavior across Linux, macOS, and Windows.

How to handle exceptions in cli command handlers?

Register a custom StdExceptionHandler using cli.StdExceptionHandler method to catch and handle exceptions thrown during command execution, as shown in the README example. This allows for graceful error reporting without crashing the application.

What are the performance implications of cli's async schedulers?

The async schedulers like LoopScheduler run commands in a single thread, simplifying synchronization but potentially introducing latency for CPU-bound tasks. For I/O-heavy applications, such as remote sessions, the async model can improve efficiency by avoiding blocking calls.

cli — C++ CLI Library with Cisco Navigation

What is cli?

cli is a header-only C++14 library for building interactive command-line interfaces with hierarchical menus, persistent history, and autocompletion. It solves the problem of creating professional CLI tools that mimic Cisco-style interfaces, supporting both local and remote sessions via telnet. The library provides an asynchronous architecture that simplifies development of single-threaded applications without synchronization concerns.

Target Audience

C++ developers building interactive command-line tools, network management applications, or embedded systems requiring professional CLI interfaces. Particularly useful for those creating tools with hierarchical menus and remote access capabilities.

Value Proposition

Developers choose cli for its header-only simplicity, cross-platform compatibility, and rich feature set including telnet support and asynchronous architecture. It stands out by providing Cisco-style navigation patterns without external dependencies for local sessions.

A library for interactive command line interfaces in modern C++

Use Cases

Best For

Building network equipment configuration interfaces
Creating embedded system management CLIs
Developing remote administration tools with telnet access
Implementing interactive debugging consoles
Building teaching tools for command-line interface concepts
Creating hierarchical menu-driven applications

Not Ideal For

Projects requiring advanced Unicode or internationalization support without custom stream implementations
Applications needing high-performance, non-blocking I/O beyond the provided async schedulers
Teams wanting a drop-in solution with pre-defined command sets for common administrative tasks
Environments where C++14 or later is not available or where minimal dependencies are critical

Pros & Cons

Pros

Header-Only Simplicity

Being header-only means no separate compilation is needed; developers just include the headers, reducing build complexity and dependency management, as emphasized in the Installation section.

Rich Interactive Features

Provides persistent command history, tab autocompletion, hierarchical menus, and color output, mimicking professional CLI tools like Cisco interfaces, as shown in the demo GIFs and Features list.

Async and Thread-Safe Architecture

Asynchronous command execution with schedulers allows for single-threaded applications without synchronization worries, detailed in the Async programming section with examples like LoopScheduler.

Remote Session Support

Built-in telnet server enables remote CLI access, expanding usability for network management, with support for both boost and standalone asio, as described in the Dependencies and Async sections.

Cons

Limited Unicode Support

The README explicitly states that cli does not have effective Unicode support by default, requiring custom stream implementations like boost::nowide for proper handling, which adds complexity.

Dependency on Asio for Remote Features

To enable telnet server functionality, the library depends on asio (standalone or boost), adding external dependencies and setup complexity that might not be desired for local-only applications.

Niche Ecosystem and Documentation

As a specialized C++ library, it has a smaller community and less extensive documentation compared to more general CLI frameworks, which could hinder troubleshooting and adoption for broader use cases.

What is cli?

Target Audience

Value Proposition

Use Cases

Best For

Building network equipment configuration interfaces
Creating embedded system management CLIs
Developing remote administration tools with telnet access
Implementing interactive debugging consoles
Building teaching tools for command-line interface concepts
Creating hierarchical menu-driven applications

Not Ideal For

Projects requiring advanced Unicode or internationalization support without custom stream implementations
Applications needing high-performance, non-blocking I/O beyond the provided async schedulers
Teams wanting a drop-in solution with pre-defined command sets for common administrative tasks
Environments where C++14 or later is not available or where minimal dependencies are critical

Pros & Cons

Pros

Header-Only Simplicity

Being header-only means no separate compilation is needed; developers just include the headers, reducing build complexity and dependency management, as emphasized in the Installation section.

Rich Interactive Features

Provides persistent command history, tab autocompletion, hierarchical menus, and color output, mimicking professional CLI tools like Cisco interfaces, as shown in the demo GIFs and Features list.

Async and Thread-Safe Architecture

Asynchronous command execution with schedulers allows for single-threaded applications without synchronization worries, detailed in the Async programming section with examples like LoopScheduler.

Remote Session Support

Built-in telnet server enables remote CLI access, expanding usability for network management, with support for both boost and standalone asio, as described in the Dependencies and Async sections.

Cons

Limited Unicode Support

The README explicitly states that cli does not have effective Unicode support by default, requiring custom stream implementations like boost::nowide for proper handling, which adds complexity.

Dependency on Asio for Remote Features

To enable telnet server functionality, the library depends on asio (standalone or boost), adding external dependencies and setup complexity that might not be desired for local-only applications.

Niche Ecosystem and Documentation

cli

What is cli?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

cli

What is cli?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?