Class: OAuth::TTY::Commands::HelpCommand — Documentation by YARD 0.9.37

# Class: OAuth::TTY::Commands::HelpCommand

Inherits:
  OAuth::TTY::Command
  - Object
  - OAuth::TTY::Command
  - OAuth::TTY::Commands::HelpCommand
  show all

Defined in:
  lib/oauth/tty/commands/help_command.rb

## Instance Method Summary collapse

- #run ⇒ Object

### Methods inherited from OAuth::TTY::Command

#initialize, #required_options

## Constructor Details

This class inherits a constructor from OAuth::TTY::Command

## Instance Method Details

### #run ⇒ `Object`

    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    # File 'lib/oauth/tty/commands/help_command.rb', line 7

    def run
      puts <<-EOT
        Usage: oauth COMMAND [ARGS]

        Available oauth commands are:
          a, authorize  Obtain an access token and secret for a user
          q, query      Query a protected resource
          s, sign       Generate an OAuth signature

        In addition to those, there are:
          v, version    Displays the current version of the library (or --version, -v)
          h, help       Displays this help (or --help, -h)

        Tip: All commands can be run without args for specific help.

      EOT
    end