command_kit-completion

• Source
• Issues
• Documentation

Description

Adds a rake task that generates shell completion rules for a command_kit CLI. The rake task loads the CLI class and uses the completely library to generate the shell completion rules.

Features

• Supports automatically generating completion rules from a command_kit CLI
  class's options and sub-commands.
• Supports loading additional completion rules from a YAML file.

Examples

require 'command_kit/completion/task'
CommandKit::Completion::Task.new(
  class_file:  './examples/cli',
  class_name:  'Foo::CLI',
  output_file: 'completion.sh'
)

Synopsis

rake command_kit:completion

Requirements

• Ruby >= 3.0.0
• command_kit ~> 0.1
• completely ~> 0.6

License

Copyright (c) 2023 Hal Brodigan

See {file:LICENSE.txt} for details.