Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Allows defining multiple commands within a Cinch Plugin.
Ruby
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib/cinch
spec
.document
.gitignore
.rspec
.yardopts
ChangeLog.md
LICENSE.txt
README.md
Rakefile
cinch-commands.gemspec
gemspec.yml

README.md

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.

Something went wrong with that request. Please try again.