Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Do not merge] Adds proof-of-concept for man page #686

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.PHONY: all gen build
.PHONY: all gen build man

all: gen build
all: gen build man

gen: temporalcli/commands.gen.go

Expand All @@ -9,3 +9,17 @@ temporalcli/commands.gen.go: temporalcli/commandsgen/commands.yml

build:
go build ./cmd/temporal

man: build
@mkdir -p man
@if [ -f ./temporal ]; then \
help2man \
-N \
--name="1.1.0 (Server 1.25.0, UI 2.30.3)" \
--version-string="temporal CLI" \
--manual="temporal CLI" \
--section=7 ./temporal > man/temporal.7; \
else \
echo "Error: './temporal' executable not found."; \
exit 1; \
fi
84 changes: 84 additions & 0 deletions man/temporal.7
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH TEMPORAL "7" "October 2024" "temporal CLI" "temporal CLI"
.SH NAME
temporal \- 1.1.0 (Server 1.25.0, UI 2.30.3)
.SH DESCRIPTION
The Temporal CLI manages, monitors, and debugs Temporal apps. It lets you run
a local Temporal Service, start Workflow Executions, pass messages to running
Workflows, inspect state, and more.
.SS "* Start a local development service:"
.IP
`temporal server start\-dev`
.SS "* View help: pass `--help` to any command:"
.IP
`temporal activity complete \fB\-\-help\fR`
.SS "Usage:"
.IP
temporal [command]
.SS "Available Commands:"
.TP
activity
Complete or fail an Activity
.TP
batch
Manage running batch jobs
.TP
completion
Generate the autocompletion script for the specified shell
.TP
env
Manage environments
.TP
help
Help about any command
.TP
operator
Manage Temporal deployments
.TP
schedule
Perform operations on Schedules
.TP
server
Run Temporal Server
.TP
task\-queue
Manage Task Queues
.TP
workflow
Start, list, and operate on Workflows
.SS "Flags:"
.TP
\fB\-\-color\fR string
Output coloring. Accepted values: always, never, auto. (default "auto")
.TP
\fB\-\-command\-timeout\fR duration
Timeout for the span of a command. (default 0s)
.TP
\fB\-\-env\fR ENV
Active environment name (ENV). (default "default")
.TP
\fB\-\-env\-file\fR $HOME/.config/temporalio/temporal.yaml
Path to environment settings file. (defaults to $HOME/.config/temporalio/temporal.yaml).
.TP
\fB\-h\fR, \fB\-\-help\fR
help for temporal
.TP
\fB\-\-log\-format\fR string
Log format. Options are: text, json. (default "text")
.TP
\fB\-\-log\-level\fR server start\-dev
Log level. Default is "info" for most commands and "warn" for server start\-dev. Accepted values: debug, info, warn, error, never. (default "info")
.TP
\fB\-\-no\-json\-shorthand\-payloads\fR
Raw payload output, even if they are JSON.
.TP
\fB\-o\fR, \fB\-\-output\fR string
Non\-logging data output format. Accepted values: text, json, jsonl, none. (default "text")
.TP
\fB\-\-time\-format\fR string
Time format. Accepted values: relative, iso, raw. (default "relative")
.TP
\fB\-v\fR, \fB\-\-version\fR
version for temporal
.PP
Use "temporal [command] \fB\-\-help\fR" for more information about a command.
Loading