egt.1

.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.2.
.TH EGT "1" "October 2022" "egt 0.4" "User Commands"
.SH NAME
egt \- egt
.SH DESCRIPTION
usage: egt [\-h] [\-\-version] [\-\-verbose] [\-\-debug]
.IP
{scan,list,summary,term,work,edit,grep,mrconfig,weekrpt,print_log,cat,annotate,archive,backup,next,completion}
\&...
.PP
Enrico's getting things done
.SS "positional arguments:"
.TP
{scan,list,summary,term,work,edit,grep,mrconfig,weekrpt,print_log,cat,annotate,archive,backup,next,completion}
egt subcommands
.TP
scan
Update the list of known project files, by scanning
everything below the
.TP
list
List known projects.
.TP
summary
Print a summary of the activity on all projects
.TP
term
Open a terminal in the directory of the given
project(s)
.TP
work
Open a terminal in a project directory, and edit the
project file.
.TP
edit
Open a terminal in a project directory, and edit the
project file.
.TP
grep
Run 'git grep' on all project .git dirs
.TP
mrconfig
Print a mr configuration snippet for all git projects
.TP
weekrpt
Compute weekly reports
.TP
print_log
Output the log for one or more projects
.TP
cat
Output the content of one or more project files
.TP
annotate
Print a project file on stdout, annotating its
contents with anything
.TP
archive
Output the log for one or more projects
.TP
backup
Backup of egt project core information
.TP
next
Show the top of the notes of the most recent .egt
files
.TP
completion
Tab completion support
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-version\fR
show program's version number and exit
.TP
\fB\-\-verbose\fR, \fB\-v\fR
verbose output
.TP
\fB\-\-debug\fR
debug output
.SH  SCAN  SUBCOMMAND

usage: egt scan [\-h] [\-v] [\-\-debug] [\-\-archived] [roots ...]
.SS "positional arguments:"
.TP
roots
root directories to search (default: the home directory)
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debugging output
.TP
\fB\-\-archived\fR
also show archived projects
.SH  LIST  SUBCOMMAND

usage: egt list [\-h] [\-v] [\-\-debug] [\-\-archived] [\-\-files] [\-\-age]
.IP
.SH "PROJECTS ..."
.SS "positional arguments:"
.TP
projects
projects list or filter (default: all)
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debugging output
.TP
\fB\-\-archived\fR
also show archived projects
.TP
\fB\-\-files\fR
list paths to .egt files
.TP
\fB\-\-age\fR
sort by age and show ages
.SH  SUMMARY  SUBCOMMAND

usage: egt summary [\-h] [\-v] [\-\-debug] [\-\-archived]
.IP
[\-\-name | \fB\-\-tasks\fR | \fB\-\-update]\fR [\-\-width WIDTH]
[projects ...] [projects ...]
.SS "positional arguments:"
.TP
projects
projects list or filter (default: all)
.TP
projects
list of projects to summarise (default: all)
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debugging output
.TP
\fB\-\-archived\fR
also show archived projects
.TP
\fB\-\-name\fR
sort projects by name
.TP
\fB\-\-tasks\fR
sort projects by number of tasks
.TP
\fB\-\-update\fR
sort projects by last log\-update (default)
.TP
\fB\-\-width\fR WIDTH
width of output, useful when piped to other command
.SH  TERM  SUBCOMMAND

usage: egt term [\-h] [\-v] [\-\-debug] [\-\-archived] [projects ...]
.SS "positional arguments:"
.TP
projects
projects list or filter (default: all)
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debugging output
.TP
\fB\-\-archived\fR
also show archived projects
.SH  WORK  SUBCOMMAND

usage: egt work [\-h] [\-v] [\-\-debug] [\-\-archived] [projects ...]
.SS "positional arguments:"
.TP
projects
projects list or filter (default: all)
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debugging output
.TP
\fB\-\-archived\fR
also show archived projects
.SH  EDIT  SUBCOMMAND

usage: egt edit [\-h] [\-v] [\-\-debug] [\-\-archived] [projects ...]
.SS "positional arguments:"
.TP
projects
projects list or filter (default: all)
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debugging output
.TP
\fB\-\-archived\fR
also show archived projects
.SH  GREP  SUBCOMMAND

usage: egt grep [\-h] [\-v] [\-\-debug] [\-\-archived] pattern [projects ...]
.SS "positional arguments:"
.TP
pattern
pattern to pass to git grep
.TP
projects
project(s) to work on
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debugging output
.TP
\fB\-\-archived\fR
also show archived projects
.SH  MRCONFIG  SUBCOMMAND

usage: egt mrconfig [\-h] [\-v] [\-\-debug] [\-\-archived] [projects ...]
.SS "positional arguments:"
.TP
projects
projects list or filter (default: all)
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debugging output
.TP
\fB\-\-archived\fR
also show archived projects
.SH  WEEKRPT  SUBCOMMAND

usage: egt weekrpt [\-h] [\-v] [\-\-debug] [\-\-archived] [projects ...]
.SS "positional arguments:"
.TP
projects
projects list or filter (default: all)
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debugging output
.TP
\fB\-\-archived\fR
also show archived projects
.SH  PRINT_LOG  SUBCOMMAND

usage: egt print_log [\-h] [\-v] [\-\-debug] [\-\-archived] [projects ...]
.SS "positional arguments:"
.TP
projects
projects list or filter (default: all)
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debugging output
.TP
\fB\-\-archived\fR
also show archived projects
.SH  CAT  SUBCOMMAND

usage: egt cat [\-h] [\-v] [\-\-debug] [\-\-archived] [\-r | \fB\-l]\fR [projects ...]
.SS "positional arguments:"
.TP
projects
projects list or filter (default: all)
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debugging output
.TP
\fB\-\-archived\fR
also show archived projects
.TP
\fB\-r\fR, \fB\-\-raw\fR
print the egt\-file(s) directly, do not update task info)
.TP
\fB\-l\fR, \fB\-\-log\fR
limit output to (merged) project log
.SH  ANNOTATE  SUBCOMMAND

usage: egt annotate [\-h] [\-v] [\-\-debug] [\-\-archived] [\-\-stdin] project
.SS "positional arguments:"
.TP
project
project to work on
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debugging output
.TP
\fB\-\-archived\fR
also show archived projects
.TP
\fB\-\-stdin\fR
read project file data from stdin
.SH  ARCHIVE  SUBCOMMAND

usage: egt archive [\-h] [\-v] [\-\-debug] [\-\-archived] [\-\-month MONTH]
.IP
[\-\-remove\-old] [\-\-output OUTPUT] [\-\-singlefile]
.SS "positional arguments:"
.TP
projects
projects list or filter (default: all)
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debugging output
.TP
\fB\-\-archived\fR
also show archived projects
.TP
\fB\-\-month\fR MONTH, \fB\-m\fR MONTH
print log until the given month (default: 2022\-09)
.TP
\fB\-\-remove\-old\fR
rewrite the original project file removing archived
entries
.TP
\fB\-\-output\fR OUTPUT, \fB\-o\fR OUTPUT
output of aggregated archived logs (default: standard
output)
.TP
\fB\-\-singlefile\fR, \fB\-s\fR
write archive log lines into a single file
.SH  BACKUP  SUBCOMMAND

usage: egt backup [\-h] [\-v] [\-\-debug] [\-\-archived] [projects ...]
.SS "positional arguments:"
.TP
projects
projects list or filter (default: all)
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debugging output
.TP
\fB\-\-archived\fR
also show archived projects
.SH  NEXT  SUBCOMMAND

usage: egt next [\-h] [\-v] [\-\-debug] [\-\-archived] [projects ...]
.SS "positional arguments:"
.TP
projects
projects list or filter (default: all)
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debugging output
.TP
\fB\-\-archived\fR
also show archived projects
.SH  COMPLETION  SUBCOMMAND

usage: egt completion [\-h] [\-v] [\-\-debug] [\-\-archived] [subcommand]
.SS "positional arguments:"
.TP
subcommand
command for which to provide completion
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debugging output
.TP
\fB\-\-archived\fR
also show archived projects