{{- /*gotype: git.sr.ht/~ewy/pik/man/manview.ManData*/ -}} .TH PIK 1 {{.Version}} {{.Runtime}} .sh NAME pik \- file based task runner .SH SYNOPSIS .B pik [\fIOPTION\fR]... [[\fISOURCE\fR] [\fITARGET\fR]] [\fIARG\fR]... .SH DESCRIPTION .B pik executes scripts from the .pik folder or external runners. .SH EXAMPLES .PP Invoke .B pik without arguments to open the tui. .PP Given a .pik folder in your current working directory containing "script.sh", calling .B pik script will start that script. .PP To start a script from another location, pass that as the SOURCE before the TARGET. Example: .B pik project build from \fI/project/src/dir\fR (and similar paths) will start \fI/project/.pik/build.py\fR if it exists. .SH OPTIONS {{ range .Flags -}} .TP .BR \-\-{{.Name }} {{ if .Shorthand }}, \-{{ .Shorthand }}{{ end }} = {{ .Value.Type }} {{ if .DefValue }} ({{.DefValue}}) {{- end }} {{ .Usage }} {{ end }} .SH TARGET CONFIGURATION Targets can be configured with tags. Tags are put in filenames, and should have a \. before and after the tag. .PP .B EXAMPLE: test.here.single.sh has the 'here' and 'single' tag. {{ range $t, $v := .TagMap }} .TP .BR {{ $t}} {{ $v.Description }} {{ end }} .SH SOURCE CONFIGURATION Most source configuration files can contain multiple lines, including blank lines. "#" and "//" will be interpreted as comments. {{ range $f, $v := .MetaFiles -}} {{- if $v.Description }} .TP .BR .pik/{{$f}} {{ $v.Description }} {{- end -}} {{- end}} .SH EXIT CODES If the target runs and returns a non-zero error code, we pass that back to the user instead. {{ range .ExitCodes -}} .TP .BR {{ .Value }} {{ .Message }} {{ end }} .SH AUTHOR Written by Ewy: https://ewy.one/ .SH COPYRIGHT License GPLv3+: GNU GPL version 3 or later: https://gnu.org/licenses/gpl.html .PP This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.