Class: Markdo::HelpCommand

Inherits:
Command
  • Object
show all
Defined in:
lib/markdo/help_command.rb

Instance Method Summary collapse

Methods inherited from Command

#initialize

Constructor Details

This class inherits a constructor from Markdo::Command

Instance Method Details

#run ⇒ Object 



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

def run
  @stderr.puts <<-EOF
Markdown-based task manager.

add "string"          Add a task to the inbox.  (Set $MARKDO_ROOT and $MARKDO_INBOX.)
edit                  Edit $MARKDO_ROOT in $EDITOR.
help, --help          Display this help text.
overview              Get overview of overdue, starred, today's, and tomorrow's tasks.
overdue               Search *.md files for previous dates.  (YYYY-MM-DD format.)
tag "string"          Search *.md files for @string.
today                 Search *.md files for today's date.  (YYYY-MM-DD format.)
tomorrow              Search *.md files for tomorrow's date.  (YYYY-MM-DD format.)
rss                   Make an RSS feed of all links in Markdo.  Useful as a live bookmark.
star, starred         Search *.md files for @star.
query, q "string"     Search *.md files for string.
version, --version    Display the version.
EOF

  exit 1
end