Skip to content

USAGE.rst

Latest commit

 

History

History
111 lines (78 loc) · 3.2 KB

USAGE.rst

File metadata and controls

111 lines (78 loc) · 3.2 KB

Contents

yana --help

usage: yana.py [-h] [-d] [-v] [--tag-regex TAG_REGEX] [-n]
               [--note-regex NOTE_REGEX]
               {edit,list,show,tags} ...

Yet Another Notes App - this one builds on what will persist (plaint text
files and a file system).

positional arguments:
  {edit,list,show,tags}
                        sub command
    edit                edit notes
    list                lists notes
    show                show notes
    tags                show used tags for notes

optional arguments:
  -h, --help            show this help message and exit
  -d, --debug           turn on debug messages (default: False)
  -v, --verbose         turn on verbose messages (default: False)
  --tag-regex TAG_REGEX
                        regular expression used to identify tags in notes
                        (default: (?m)(?<!\[)(?:#)([\w-]+))
  -n, --new             ignore non-existing notes / allow new notes to be
                        created (default: False)
  --note-regex NOTE_REGEX
                        regular expression used to identify notes paths
                        (default: .*\.note$)

Now you know.

yana edit --help

usage: yana.py edit [-h] [-s] [-t] [-w] [--editor EDITOR]
                    [--terminal-editor TERMINAL_EDITOR]
                    [query [query ...]]

positional arguments:
  query                 a query for notes (searches: recursively in the file
                        system, last listed by index, last listed by pattern-
                        matching paths).

optional arguments:
  -h, --help            show this help message and exit
  -s, --separate        run editor for every note separately
  -t, --terminal        use a terminal editor
  -w, --wait            wait for the editor to finish
  --editor EDITOR       default editor to use
  --terminal-editor TERMINAL_EDITOR
                        default editor on terminal to use

yana list --help

usage: yana.py list [-h] [-t] [query [query ...]]

positional arguments:
  query       a query for notes (searches: recursively in the file system,
              last listed by index, last listed by pattern-matching paths).

optional arguments:
  -h, --help  show this help message and exit
  -t, --tags  list tags as well

yana show --help

usage: yana.py show [-h] [query [query ...]]

positional arguments:
  query       a query for notes (searches: recursively in the file system,
              last listed by index, last listed by pattern-matching paths).

optional arguments:
  -h, --help  show this help message and exit

yana tags --help

usage: yana.py tags [-h] [-s] [-n] [query [query ...]]

positional arguments:
  query        a query for notes (searches: recursively in the file system,
               last listed by index, last listed by pattern-matching paths).

optional arguments:
  -h, --help   show this help message and exit
  -s, --sort   sort output
  -n, --notes  show notes containing the corresponding tag