How to install and set up dry-cli in a Ruby project?

Install the gem via `gem install dry-cli` or add it to your Gemfile. Then, define commands by extending dry-cli's base classes, following the examples in the user documentation on dry-rb.org for a structured setup.

dry-cli vs Thor: which is better for Ruby CLI tools?

dry-cli offers a more explicit, composable approach ideal for maintainable and testable applications, while Thor is more opinionated with a larger ecosystem, making it better for quick prototyping or if you're already using Thor.

How to define nested commands with dry-cli?

Use the command registration feature to create namespaces and hierarchies. Define subcommands within parent commands, and dry-cli handles routing and help generation automatically, as described in the documentation.

Does dry-cli support validation for command-line arguments?

Yes, dry-cli includes built-in option parsing with validation capabilities. You can specify types and constraints for arguments, ensuring they meet your application's requirements without extra code.

Can I use dry-cli with Ruby on Rails applications?

Yes, dry-cli can be integrated into Rails projects for custom CLI tools or generators, though Rails has its own generator system, so it might be more suitable for non-Rails-specific tasks.

How to test CLI commands built with dry-cli?

dry-cli is designed with testability in mind, allowing easy unit and integration testing. You can simulate command execution using Ruby testing frameworks, as emphasized in the key features.

Open-Awesome

dry-cli

MITRubyv1.4.1

A general-purpose Command Line Interface (CLI) framework for Ruby applications.

Visit Website GitHub

353 stars39 forks0 contributors

What is dry-cli?

dry-cli is a general-purpose Command Line Interface (CLI) framework for Ruby that enables developers to build structured and maintainable command-line applications. It simplifies defining commands, parsing options, and generating help text, making CLI development more efficient and organized.

Target Audience

Ruby developers building command-line tools, scripts, or applications who need a robust and extensible framework for managing CLI interactions.

Value Proposition

Developers choose dry-cli for its clean API, extensibility, and alignment with the dry-rb ecosystem's principles of simplicity and composability, offering a reliable alternative to ad-hoc CLI solutions.

Overview

General purpose Command Line Interface (CLI) framework for Ruby

Use Cases

Best For

Building structured command-line tools in Ruby
Creating maintainable CLI applications with nested commands
Parsing and validating command-line options and arguments
Generating automatic help documentation for CLI tools
Testing CLI commands with ease
Extending CLI functionality with plugins or middleware

Not Ideal For

Projects requiring minimal dependencies for very simple, one-off scripts
Teams already heavily invested in alternative CLI frameworks like Thor or GLI
Applications needing advanced interactive features like TUI or shell completion without additional setup

Pros & Cons

Pros

Structured Command Hierarchy

dry-cli enables clear namespace and hierarchy definitions for commands, making complex CLI applications more organized and maintainable, as highlighted in its command registration feature.

Built-in Option Parsing

It provides robust parsing and validation for command-line options and arguments, ensuring reliable input handling without manual effort, as mentioned in the key features.

Extensible with Plugins

The framework supports plugins and custom middleware, allowing seamless extension of functionality, aligning with the dry-rb philosophy of composability.

Automatic Help Generation

dry-cli automatically generates help text for commands and options, reducing boilerplate code and improving user documentation, a key feature emphasized in the README.

Cons

Learning Curve for Newcomers

Adhering to the dry-rb philosophy of explicitness and composability requires upfront understanding, making it less approachable for developers unfamiliar with the ecosystem.

Limited Third-Party Ecosystem

Compared to more established alternatives like Thor, dry-cli has a smaller community, resulting in fewer plugins, tutorials, and community support resources.

Lacks Advanced Features Out-of-the-Box

Features like interactive prompts, shell completion, or colored output are not included by default, often requiring additional development or integration efforts.

Frequently Asked Questions

Related Projects

TTY

Toolkit for developing sleek command line apps.

Stars2,532

Forks82

Last commit3 years ago

Slop

Simple Lightweight Option Parsing - ✨ new contributors welcome ✨

Stars1,129

Forks71

Last commit7 months ago

Commander

The complete solution for Ruby command-line executables

Stars823

Forks68

Last commit2 years ago

Clamp

a Ruby command-line application framework

Stars446

Forks51

Last commit2 months ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub