The project is in a healthy, maintained state
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 shell completion rules.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 2.0

Runtime

 Project Readme

command_kit-completion

CI Code Climate Gem Version

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

License

Copyright (c) 2023 Hal Brodigan

See {file:LICENSE.txt} for details.