summaryrefslogtreecommitdiff
path: root/man/templates/pik.1.man.tmpl
blob: 53f1cfdd86b9f8df3d15c3f394308e0bafcf9467 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
{{- /*gotype: github.com/ewy1/pik/man.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
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
will start ../../.pik/build.py if it exists.
.SH OPTIONS
{{ range .Flags -}}
.TP
.BR \-\-{{.Name }} {{ if .Shorthand }}, \-{{ .Shorthand }}{{ end }} = {{ .Value.Type }} {{ if .DefValue }} ({{.DefValue}}) {{- end }}
{{ .Usage }}
{{ end }}
.SH EXIT CODES
If the target runs and returns a non-zero error code, we pass that forward instead.
{{ range .ExitCodes -}}
.TP
.BR {{ .Value }}
{{ .Message }}
{{ end }}