nt

simple note taker
git clone git://edryd.org/nt
Log | Files | Refs | LICENSE

README.md (2094B)

      1 # nt - simple note taker
      2 
      3 ## SYNOPSIS
      4 
      5 `nt` [**-Dilvy**] [**-f** *FILE*] [**-e** *NOTE*] [**-d** *NOTE*] [**-t** [*TAG*]] [**-n** *NUM* | **-NUM**] [*NOTE* ...]
      6 
      7 ## DESCRIPTION
      8 
      9 Simple note taker for the command line. To take a note simply run the command
     10 with the new note as arguments or from stdin. The note will be saved to a plain
     11 text file with each line being a note. The file is saved to the file either
     12 specified with **-f** or in the default one from `config.h`. Notes can have tags
     13 by prefixing the note with a tag followed by a colon. For example a note
     14 `chores: take out trash` will have the tag `chores`.
     15 
     16 ## OPTIONS
     17 
     18 **-d** *NOTE*
     19 	Delete *NOTE* from notes
     20 
     21 **-D**
     22 	Delete all notes from *FILE*
     23 
     24 **-e** *NOTE*
     25 	Edit *NOTE* with new text given through stdin
     26 
     27 **-f** *FILE*
     28 	Load *FILE* instead of default one
     29 
     30 **-i**
     31 	Force prompt to confirm action
     32 
     33 **-l**
     34 	List notes
     35 
     36 **-n** *NUM*, **-NUM**
     37 	List last *NUM* notes
     38 
     39 **-t** [*TAG*]
     40 	Search for *TAG* in notes, list all tags if no *TAG* is given
     41 
     42 **-v**
     43 	Print version info and exit
     44 
     45 **-y**
     46 	Auto reply yes to confirmation prompts
     47 
     48 ## USAGE
     49 
     50 Add simple note and list it:
     51 
     52 	$ nt clean dishes
     53 	$ nt -l
     54 	clean dishes
     55 
     56 Create note in specified file:
     57 
     58 	$ nt -f list take out trash
     59 	$ nt -f list -l
     60 	take out trash
     61 
     62 Add more notes by running command again:
     63 
     64 	$ nt wash car
     65 	$ nt -l
     66 	clean dishes
     67 	wash car
     68 	$ nt buy pie
     69 	$ nt -l
     70 	clean dishes
     71 	wash car
     72 	buy pie
     73 
     74 List just the *NUM* most recent notes:
     75 
     76 	$ nt -1
     77 	buy pie
     78 	$ nt -n 1
     79 	buy pie
     80 	$ nt -2
     81 	buy pie
     82 	wash car
     83 	$ nt -n 2
     84 	buy pie
     85 	wash car
     86 
     87 Search notes through an external program:
     88 
     89 	$ nt -l | grep pie
     90 	buy pie
     91 	$ nt make pie
     92 	$ nt -l | grep pie
     93 	buy pie
     94 	make pie
     95 
     96 Remove given note:
     97 
     98 	$ nt -yd buy pie
     99 	$ nt -l
    100 	clean dishes
    101 	wash car
    102 	make pie
    103 
    104 Edit note with new text given from stdin:
    105 
    106 	$ echo eat pie | nt -e make pie
    107 	$ nt -l
    108 	clean dishes
    109 	wash car
    110 	eat pie
    111 
    112 Remove all notes:
    113 
    114 	$ nt -yD
    115 	$ nt -l
    116 	$ nt -f list -yD
    117 	$ nt -f list -l
    118 
    119 ## AUTHOR
    120 
    121 Ed van Bruggen <edvb54@gmail.com>
    122 
    123 ## SEE ALSO
    124 
    125 View source code at: <https://gitlab.com/edvb/nt>
    126 
    127 ## LICENSE
    128 
    129 zlib License