Commit c70bff1

Anton Golub <antongolub@antongolub.com>
2024-05-13 18:49:29
docs: provide man page (#806)
Co-authored-by: Anton Medvedev <anton@medv.io>
1 parent 73e3e1d
Changed files (2)
man/zx.1
@@ -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/)
\ No newline at end of file
package.json
@@ -51,6 +51,7 @@
   "bin": {
     "zx": "./build/cli.js"
   },
+  "man": "./man/zx.1",
   "engines": {
     "node": ">= 12.17.0"
   },
@@ -123,7 +124,7 @@
   },
   "files": [
     "build",
-    "zx.js"
+    "man"
   ],
   "prettier": {
     "semi": false,