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