mcpField
R
ruby-cli

ruby-cli

github.com/steveclarkeDevelopment36123 installsUpdated today
Repository

About ruby-cli

A skill for building Ruby command-line tools with Thor and Zeitwerk. It provides navigation for bootstrapping gems, adding commands, and creating terminal interfaces with Gum.

Key features

  1. 01Guidance for starting a CLI gem
  2. 02Thor command and subcommand patterns
  3. 03Zeitwerk autoloading conventions
  4. 04Thor output styling guidance
  5. 05Gum components for rich terminal interfaces

Use cases

  1. 01Bootstrap a Ruby CLI gem
  2. 02Add commands or subcommands to a tool
  3. 03Build terminal tables, prompts, or progress indicators

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/steveclarke/dotfiles --skill ruby-cli

After installing, type/ruby-cliin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/
bootstrap.md
gum.md
patterns.md

Details

From the project README

Ruby CLI Development

Build Ruby CLI tools using Thor for commands and Zeitwerk for autoloading.

Quick Navigation

Core Principles

  • Use compact class declarations: class GemName::Cli::Main < GemName::Cli::Base
  • Use extend self instead of module_function for utility modules
  • Keep the Base class lean - add helpers as patterns emerge

Output Styling

For basic output, use Thor's built-in say "message", :color.

For rich terminal UI (headers, tables, spinners, confirmations), use the Gum gem:

ui.header("Section Title")    # branded header with border
ui.success("Done!")           # green checkmark
ui.error("Failed")            # red X
ui.table(rows, columns: [...]) # formatted table
ui.spin("Working...") { ... } # spinner during work

See references/gum.md for setup and full API.

Tips & Gotchas

  • Add # rubocop:disable Rails/Output to UI modules (stdout is intentional in CLIs)
  • The gum gem bundles the gum binary for common platforms; GUM_INSTALL_DIR points it at a system install elsewhere

Comments

Markdown supported