Skip to content

Commit

Permalink
docs: provide man page (#806)
Browse files Browse the repository at this point in the history
Co-authored-by: Anton Medvedev <[email protected]>
  • Loading branch information
antongolub and antonmedv authored May 13, 2024
1 parent 73e3e1d commit c70bff1
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 1 deletion.
40 changes: 40 additions & 0 deletions man/zx.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
.\" Manpage for zx.
.TH man 8 "12 May 2024" "8.x" "zx man page"
.SH NAME
zx \- the zx CLI
.SH DESCRIPTION
A tool for writing better scripts.
.SH SYNOPSIS
.SS zx\fR [\fIOPTIONS\fR] \fIURI\fR
.SH OPTIONS
.SS --quiet
don't echo commands
.SS --verbose
Enables verbose mode
.SS --shell=<path>
Sets the shell to use
.SS --prefix=<command>
prefix all commands
.SS --postfix=<command>
postfix all commands
.SS --eval=<js>, -e
evaluate script
.SS --install, -i
install dependencies
.SS --repl
start repl
.SS --version, -v
print current zx version
.SS --help, -h
Print command help and options
.SH EXAMPLES
.TP
.I zx --verbose script.js
.TP
.I zx https://example.com/script.js
.TP
.I zx -e '$`ls -l`'
.SH BUGS
https://github.com/google/zx/issues.
.SH AUTHOR
Anton Medvedev (https://medv.io/)
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
"bin": {
"zx": "./build/cli.js"
},
"man": "./man/zx.1",
"engines": {
"node": ">= 12.17.0"
},
Expand Down Expand Up @@ -123,7 +124,7 @@
},
"files": [
"build",
"zx.js"
"man"
],
"prettier": {
"semi": false,
Expand Down

0 comments on commit c70bff1

Please sign in to comment.