feedwarrior

Slim, portable tooling for creating and distributing decentralized append logs
git clone git://git.defalsify.org/logwarrior.git
Info | Log | Files | Refs | README | LICENSE

README.md (3357B)


      1 # NAME
      2 
      3 feedwarrior - Feeds, warrior style
      4 
      5 # DESCRIPTION
      6 
      7 Inspired by [](https//taskwarrior.org), this project seeks to simplify
      8 the creation and maintenance of engineering work logs.
      9 
     10 Entries of each individual log has core text content. Additionally,
     11 every entry may have any number of file attachments associated with it.
     12 
     13 # SYNOPSIS
     14 
     15 **feedwarrior** add \[ -c config_file\] \[ -z \] \[ \--task-id \] \[
     16 \--task-uuid \] \< -s subject \>
     17 
     18 **feedwarrior** attach \[ -c config_file\] \[ -z \] \< -e entry \> file
     19 
     20 **feedwarrior** create \[ -c config_file\] \[ \--alias name \]
     21 
     22 **feedwarrior** entry \[ -c config_file\] \[ -z \] \[ \--task-id \] \[
     23 \--task-uuid \] \< -s subject \> \< path_to_content \>
     24 
     25 **feedwarrior** list \[ -c config_file\]
     26 
     27 **feedwarrior** show \[ -c config_file\] \< -l feed_id \>
     28 
     29 ## Common options
     30 
     31 **-l***log_id*
     32 
     33 :   Log id to operate on. May be the full uuid or the alias defined at
     34     creation time.
     35 
     36 **-c***config_file*
     37 
     38 :   Load configuration from file.
     39 
     40 ## Options for show
     41 
     42 **\--headers**
     43 
     44 :   Include multipart-headers in output.
     45 
     46 ## Options for attach
     47 
     48 **-e***entry_id*
     49 
     50 :   uuid of entry to attach file to.
     51 
     52 ## Options for create
     53 
     54 **\--alias***alias_id*
     55 
     56 :   Create log id alias that may be used as argument to **-l** for
     57     future operations.
     58 
     59 ## Options for add and entry
     60 
     61 **-s***subject*
     62 
     63 :   Entry subject.
     64 
     65 **\--task-id***id*
     66 
     67 :   Associate the log entry with the given taskwarrior numeric id. This
     68     is a quasi-magical instruction which will resolve to the actual
     69     taskwarrior uuid.
     70 
     71 **\--task-uuid***uuid*
     72 
     73 :   Associate the log entry with the given taskwarrior numeric uuid.
     74 
     75 # ATTACHMENTS
     76 
     77 Both **feedwarrior add** and **feedwarrior entry** will return the
     78 created entry id.
     79 
     80 This id can be used further with the **-e** flag for attachments.
     81 
     82 Any file in any format may be an attachment. The feedwarrior tool
     83 imposes little if no restriction on what data qualifies as valid
     84 attachment data.
     85 
     86 # INTERACTIVE ENTRIES
     87 
     88 The **feedwarrior add** command enables interactive definition of
     89 textual update entry contents.
     90 
     91 It will open an editor (at the moment hardcoded to **vim**) to receive
     92 the contents.
     93 
     94 # DATA STORE
     95 
     96 Log entries are stored as email-like MIME Multipart messages, wrapped in
     97 a json metadata structure.
     98 
     99 Only the default, simple filesystem structure is currently available as
    100 storage backend.
    101 
    102 # EXAMPLE
    103 
    104     # create feed
    105     feedwarrior create --alias myfeed
    106 
    107     ¤ add log entry
    108     ENTRY=`feedwarrior -l myfeed entry -s "first update" /path/to/contents.txt
    109 
    110     # attach file to entry
    111     feedwarrior attach -e $ENTRY <attachment_file>
    112 
    113     ¤ interactively add log entry contents
    114     entry=`feedwarrior -l myfeed add -s "second update" 
    115 
    116     # show current state of feed (chronologically)
    117     feedwarrior -l myfeed show
    118 
    119 # LICENSE
    120 
    121 This documentation and its source is licensed under the Creative Commons
    122 Attribution-Sharealike 4.0 International license.
    123 
    124 The source code of the tool this documentation describes is licensed
    125 under the GNU General Public License 3.0.
    126 
    127 # COPYRIGHT AND CONTACT
    128 
    129 [Louis Holbrook](mailto:dev@holbrook.no)
    130 
    131 [](https://holbrook.no)https://holbrook.no
    132 
    133 PGP: 59A844A484AC11253D3A3E9DCDCBD24DD1D0E001
    134 
    135 # SOURCE CODE
    136 
    137 https://holbrook.no/src/feedwarrior/log.html
    138 
    139 
    140 # ABOUT THIS DOCUMENT
    141 
    142 This document was generated using `pandoc -f man -t markdown ...`