timewarrior/doc/grammar.txt

CLI Syntax
----------
The CLI shall have a well-defined and unambiguous grammar.

    timew start|stop [<tagset>]
    timew track <interval> [<tagset>]
    timew clear <tagset>|<interval>
    timew continue
    timew

    timew [<filter>] report <report>

    timew define holidays <locale>|none
    timew define holidays [work] <date>
    timew define week <day>[- <day>] [, <day>] ...
    timew define day [<day>] start|end <time>

    timew define tag <tag>
    timew define tag <tag> description <string>
    timew define tag <tag> start|end <date>
    timew define tag <tag> budget <number> <units> per <unit>
    timew define tag <tag> budget <number> <units> total
    timew define tag <tag> overlap
    timew define tag <tag> color <color>

    timew undo

    timew tags
    timew gaps [<interval>]
    timew extensions

    timew export [<interval>] [<tagset>]
    timew import <file>|- ...

    timew help [<command>|<keyword>|examples]
    timew diagnostics
    timew log mark|<string>


CLI Grammar
-----------
Assumed built-in types:
  <datetime>
  <duration>
  <time>
  <string>

  interval:  <timestamp> "-" <timestamp>
             <timestamp> "to" <timestamp>
             <timestamp> "for" <duration>
             "from" <timestamp> "to" <timestamp>
             "until" <timestamp>
             "from" <timestamp>

  timestamp: <day> <time>

  tagset:    <tag>+

  tag:       string


Keywords
--------
There are built-in and custom keywords, that look like this:

  :fill
  :quiet

They begin with a colon, and are heuristics for Timewarrior. They can override
feedback (:quiet) or offer guidance on how to create an interval (:fill). The
supported keywords are:

  :fill
  :backfill
  :interrupt
  :quiet
  :x          (user­defined via rules)

---