0.0
No commit activity in last 3 years
No release in over 3 years
Allows defining multiple commands within a Cinch Plugin. Also provides a !help command with detailed output.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 2.4
~> 0.7

Runtime

~> 2.0
 Project Readme

cinch-commands

Description

Allows defining multiple commands within a Cinch Plugin.

Features

  • Argument types.
  • !help command with detailed output:
    • Usages
    • Summaries
    • Descriptions

Examples

require 'cinch/commands'

class MyPlugin

  include Cinch::Plugin
  include Cinch::Commands

  command :foo, {arg1: :string, arg2: :integer},
                summary:     "Does foo",
                description: %{
                  ...
                }

  command :bar, {name: :string},
          aliases: [:b]

  def foo(m,arg1,arg2)
  end

  def bar(m,name)
  end

end

Requirements

Install

$ gem install cinch-commands

Copyright

Copyright (c) 2012-2013 Hal Brodigan

See {file:LICENSE.txt} for details.