Giter Club home page Giter Club logo

cinch-commands's Introduction

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,
          [{name: "arg1", format: :string, optional: false},
           {name: "arg2", format: :integer, optional: false}],
          summary:     "Does foo",
          description: "example"\
          " more info as well"

  command :bar, [{ name: "NAME", format: :string, optional: false}],
          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.

cinch-commands's People

Contributors

postmodern avatar xzanth avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.