path: root/git-of-theseus-analyze.1

.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH GIT-OF-THESEUS-ANALYZE "1" "February 2024" "https://github.com/erikbern/git-of-theseus/" "User Commands"
.SH NAME
git-of-theseus-analyze \- manual page for git-of-theseus-analyze 0.3.4
.SH USAGE
git\-of\-theseus\-analyze [\-h] [\-\-cohortfm COHORTFM] [\-\-interval INTERVAL] [\-\-ignore IGNORE] [\-\-only ONLY] [\-\-outdir OUTDIR] [\-\-branch BRANCH] [\-\-ignore\-whitespace] [\-\-all\-filetypes] [\-\-quiet] [\-\-procs PROCS] [\-\-opt] repo_dir
.PP
.SS "positional arguments:"
.IP
repo_dir
.SH DESCRIPTION
Analyze git repo
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-cohortfm\fR COHORTFM
A Python datetime format string such as "%Y" for
creating cohorts (default: %Y)
.TP
\fB\-\-interval\fR INTERVAL
Min difference between commits to analyze (default:
604800s)
.TP
\fB\-\-ignore\fR IGNORE
File patterns that should be ignored (can provide
multiple, will each subtract independently). Uses glob
syntax and generally needs to be shell escaped. For
instance, to ignore a subdirectory `foo/`, run `git\-oftheseus . \fB\-\-ignore\fR 'foo/**'`.
.TP
\fB\-\-only\fR ONLY
File patterns that can match. Multiple can be provided.
If at least one is provided, every file has to match at
least one. Uses glob syntax and typically has to be
shell escaped. In order to analytize a subdirectory
`bar/`, run `git\-of\-theseus . \fB\-\-only\fR 'bar/**'`
.TP
\fB\-\-outdir\fR OUTDIR
Output directory to store results (default: .)
.TP
\fB\-\-branch\fR BRANCH
Branch to track (default: master)
.TP
\fB\-\-ignore\-whitespace\fR
Ignore whitespace changes when running git blame.
.TP
\fB\-\-all\-filetypes\fR
Include all files (if not set then will only analyze *.
abnf,*.cmake,*.reg,*.rei,id_ecdsa,*.nb,*.g,*.hs,*.psl,*
\&.nt,*.cirru,bashrc,*.eex,*.jl,*.u2,*.vark,*.rb,*.featur
e,*.croc,*.3pm,*.ts,*.xml.j2,*.js.jinja2,*.rnc,*.idl,*.
todotxt,Makefile,*.r,*.sh,*.zone,*.elm,meson.build,*.nl
,*.ttl,*.hx,*.pem,*.pyx,*.lcry,*.agda,dhandler,*.css.in
,*.lagda,lighttpd.conf,poetry.lock,SConstruct,*.bqn,*.a
t,*.mod,*.nix,*.sv,*.n,*.apln,*.ini,*.pig,*.fy,*.sql,*.
xtm,*.slice,*.inf,*.plt,.Rprofile,*.decls,*.dobjdump,*.po,*.p,*.pro,*.explain,*.reb,BUILD,id_rsa,*.s
l,*.bash,.bash_*,*.stan,*.ph,*.pot,*.gdc,*.kql,*.icl,*.
PRG,*.qbs,*.xmi,autohandler,*.rakumod,*.reds,*.scm,*.my
t,*.gradle,*.yaml.jinja2,*.cfm,*.adb,*.aux,*.mli,*.scss
,*.jsonl,*.scd,*.H,.ldaprc,*.el,*.bnf,*.pmod,*.cadl,*.l
idr,*.S,*.COB,_exrc,Dockerfile,control,*.dylan\-console,
*.red,*.aj,*.ceylon,*.mjs,*.jp,*.css.j2,*.mqh,*.au3,*.g
sx,*.m2,*.snbt,.gvimrc,*.xm,*.rs.in,*.cljs,*.siv,*.logt
alk,*.ns2,*.capnp,*.man,*.pwn,*.intr,*.praat,*.webidl,*
\&.cjs,*.mly,*.xhtml.j2,*.ik,*.rbw,*.exs,*.asax,*.tac,*.v
,*.evoque,*.react,*.twig,*.lgt,*.bc,*.eg,*.js.j2,source
s.list,*.m,*.docker,*.fun,*.qvs,*.bat,*.p6,*.camkes,*.p
sc,*.xq,*.rql,*.Rd,*.smv,*.asn1,*.peg,*.as,*.BAS,*.mos,
*.s,*.cu,*.pyw,*.scad,*.sol,*.ascx,*.mount,*.eh,Pipfile
\&.lock,*.proc,*.target,*.nimrod,*.aug,*.gsql,*.mu,*.kmsg
,*.jy,*.jsonld,*.ldif,*.fst,*.pyi,*.tpl,*.sql.jinja2,*.
ado,*.jslt,*.bzl,*.ijs,.kshrc,WORKSPACE,*.ooc,*.portugo
l,*.[gs]sed,*.leex,*.c++,*.mcschema,*.jcl,*.sp,meson_op
tions.txt,*.path,.zshrc,*.rita,*.ssp,*.vcl,*.smithy,*.s
hell\-session,id_ed25519,*.proto,*.rex,*.hpp,*.treetop,*
\&.F,*.f90,*.htm.j2,*.graph,*.rkt,*.cfc,*.cry,*.groovy,*.
xtend,*.lid,*.sage,*.factor,*.vbs,*.sla,*.py3tb,*.swap,
*.monkey,*.bib,.vimrc,*.rl,*.lua,*.asc,*.f,*.dot,*.moon
,*.tex,*.thrift,*.hlsli,*.F03,*.b,*.gsp,BUCK,*.nasm,id_
ecdsa_sk,*.odin,*.h++,*.svh,*.1p,*.kts,*.scope,*.cyp,*.
hdp,*.handlebars,*.htm.jinja2,*.rx,*.bst,*.tf,*.inc,*.f
s,*.sql.j2,*.pxd,*.hcl,*.html,*.hxml,*.gd,*.asm,*.lpad,
*.erl,*.sci,*.VBS,*.vm,*.wgsl,*.e,*.mcfunction,*.rst,*.
be,*.cpl,*.gv,*.mk,*.plot,*.mc,*.ans,*.cmd,*.cml,SConsc
ript,*.pm6,*.cfml,*.fish,*.prolog,*.abap,*.dmesg,*.pony
,*.tid,*.xhtml,*.pc,*.fhtml,*.sig,*.xmlul4,*.kk,*.html.
j2,*.vert,.editorconfig,*.adlx,*.gi,*.go,*.cobjdump,*.mq5,*.ino,*.fan,*.jag,ldap.conf,*.rktd,*.shex
,GNUmakefile,*.flo,*.robot,*.dyl,*.psi,*.x10,*.cpsa,*.c
ddl,*.st,*.cl,*.pike,*.F90,*.aheui,*.cob,Pipfile,*.pxi,
*.icon,*.pm,*.MIPS,*.sc,*.objdump\-intel,.csl,*.qvw,*.mo
o,*.exlib,*.vpr,.exrc,*.pl6,*.mak,*.automount,*.zep,*.j
,*.nbp,*.css,*.dtsi,*.ml,*.ptls,*.pp,*.xql,*.prg,*.appl
escript,*.orc,*.thy,*.adl,*.bpl,*.vb,*.rts,*.cxx\-objdum
p,*.kif,vimrc,*.whiley,*.mm,*.jsul4,*.p6l,*.fnl,*.P,*.f
sti,*.vy,*.chai,*.flx,*.tap,apache.conf,*.crmsh,*.rhtml
,*.mhtml,*.maql,*.scala,*.alg,Vagrantfile,*.ipf,*.nqp,*
\&.cr,Gemfile,*.ICON,*.kid,*.bb,nginx.conf,*.sarl,*.hh,*.
axd,*.toc,*.scdoc,*.service,*.mll,*.psm1,*.pov,termcap,
*.sil,*.rest,*.rakudoc,*.sce,*.shen,*.vapi,*.cfg,*.f03,
*.xhtml.jinja2,*.ride,*.comal,*.cp,*.fsx,*.ll,*.ti,auto
delegate,*.swg,*.ndjson,bash_*,*.bmx,*.x,*.hxx,*.pas,*.
def,*.rpf,xorg.conf,*.cw,*.sparql,*.ul4,*.lasso,*.pan,P
KGBUILD,*.i7x,*.rq,*.arw,terminfo,*.G,*.pack,*.tea,*.pa
tch,*.cssul4,*.rake,*.eml,*.dylan,*.wren,*.h,*.libsonne
t,*.mxml,*.pyul4,*.tst,pacman.conf,*.x[bp]m,*.juttle,*.
xquery,*.raku,*.perl,*.CPY,*.r3,*.gs,*.qvto,*.cxx,kshrc
,Procfile,*.aplf,*.boo,*.clj,*Spec.hs,*.zsh,*.gap,*.ahk
l,*.tlb,id_ed25519_sk,*.aplo,*.6pm,*.markdown,*.kal,*.r
e,*.vhdl,*.csh,*.tcl,*.bbc,*.ebuild,*.cls,*.ex,*.rvt,*.
usda,*.asmx,*.kusto,*.tpp,*.flxh,*.bug,*.hbs,*.nsh,*.kk
i,*Config.in*,*.instances,*.opa,terminfo.src,*.u1,*.was
t,*.sbl,*.cpy,*.wlua,*.nit,*.dpr,*.vipgrm,apache2.conf,
external.in*,*.spice,*.vim,*.rexx,.bashrc,*.hxsl,*.smal
i,.Rhistory,*.mac,*.fut,*.js.in,*.qml,*.yaml.j2,*.usd,*
\&.bf,*.edp,*.chpl,*.properties,*.snobol,*.idl4,*.rsl,*.c
offee,*.6pl,todo.txt,*.sls,*.d,id_dsa,*.k,*.idr,*.cdl,*
\&.ls,*.xi,*.adls,*.ashx,*.phtml,*.erl\-sh,*.p6m,*.t,*.php
,*.nc,*.exheres\-
0,*.mao,*.ncl,*.awk,*.xpl,*.cpp,*.frt,*.asy,*.exec,*.vh
d,*.wdiff,*.io,*.ksh,*.apl,standard\-modules.in,*.dasm,*
\&.nsi,*.ci,*.Rout,*.dts,*.desktop,*.mir,*.timer,*.i6t,*.
sass,*.diff,*.bare,*.lsl,*.mips,*.tt,*.boa,*.run,*.wat,
*.als,*.art,*.ahk,*.i,*.tasm,*.ni,zshrc,gvimrc,*.dtd,*.
ecl,*.yml.j2,*.php[345],*.rakutest,*.clay,*.htmlul4,*.r
ktl,*.lisp,*.promql,*.hrl,*.haml,*.device,*.fc,*.R,*.zi
g,*.do,Rakefile,*.pytb,*.hlsl,*.rbx,*.cf,*.sh\-session,*
\&.vp,*.pcmk,*.u,*.objdump,*.yar,*.dax,*.ezt,*.di,*.rs,*.
ly,*.exw,*.pypylog,*.c++\-objdump,*.py,*.nim,*.[1\-
9],*.apli,*.isa,*.jsx,*.mask,*.mo,*.spec,*.weechatlog,*
\&.scaml,*.bro,*.dyalog,*.kt,*.pidl,*.yang,*.lean,Makefil
e.*,*.tal,*.spt,*.socket,*.darcspatch,*.cypher,*.ada,*.
dg,*.ps1,*.pl,*.cs,*.gemspec,*.mt,*.xqm,*.zeek,*.cljc,*
\&.idc,*.cdf,*.savi,*.toml,*.dasm16,*.es,Kconfig*,*.befun
ge,*.kn,*.duby,*.html.jinja2,*.jsgf,*.pug,*.bas,.Renvir
on,*.carbon,*.ms,*.sqlite3\-
console,_vimrc,*.jsonnet,*.xul.in,*.csd,*.hy,*.tcsh,*.t
yposcript,*.golo,*.vala,*.yml.jinja2,*.css.jinja2,*.apl
c,*.func,makefile,*.ASM,*.jsm,*.msc,*.py2tb,*.ss,*.jbst
,*.CPP,*.escript,termcap.src,BUILD.bazel,*.ng2,*.fif,*.
teal,*.ABAP,*.geo,*.ebnf,*.slim,*.sgf,.SRCINFO,*.sas,*.
liquid,*.jade,*.c,*.duel,*.tnt,*.ma,*.sco,*.less,*.gcod
e,*.xpp,squid.conf,*.icn,*.xqy,*.dcl,*.frag,*.cps,*.res
ource,*.cuh,*.sml,*.C,*.mi,*.eclass,*.hsail,*.tmpl,*.lh
s,*.sieve,*.ptx,*.aes,*.mq4,*.q,*.js,*.sed,*.load,*.cpp
\fB\-objdump\fR,*.dart,*.lasso[89],*.fsi,*.ec,*.SAS,CMakeLists
\&.txt,*.prql,*.xml.jinja2,*.elpi,*.CBL,*.graphql,*.aspx,
*.arexx,*.lsp,*.gst,*.blp,*.swift,*.dpatch,*.fancypack,
*.htm,*.ads,.htaccess,*.cbl,*.cc,*.java,_gvimrc,*.udo,S
ingularity,*.adlf,*.max,ldaprc,*.jsp,*.hyb
.TP
\fB\-\-quiet\fR
Disable all console output (default: False)
.TP
\fB\-\-procs\fR PROCS
Number of processes to use. There is a point of
diminishing returns, and RAM may become an issue on
large repos (default: 2)
.TP
\fB\-\-opt\fR
Generates git commit\-graph; Improves performance at the
cost of some (~80KB/kCommit) disk space (default:
False)