Add automatic README update to precommit hooks

con · Jun 9, 2024 · 42a7d45 · 42a7d45
1 parent be338d0
commit 42a7d45
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 4 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -29,3 +29,9 @@ repos:
   rev: v2.2.6
   hooks:
   - id: codespell
+- repo: local
+  hooks:
+    - id: update-readme
+      name: Update README with --help output
+      entry: ./.update-readme-help.sh
+      language: system
diff --git a/README.md b/README.md
@@ -9,20 +9,23 @@ A process wrapper script that monitors the execution of a command.
 ```shell
 > duct --help
 
-usage: duct [-h] [-p OUTPUT_PREFIX] [--sample-interval SAMPLE_INTERVAL]
+<!--- BEGIN HELP -->
+usage: duct [-h] [--version] [-p OUTPUT_PREFIX]
+            [--sample-interval SAMPLE_INTERVAL]
             [--report-interval REPORT_INTERVAL] [-c {all,none,stdout,stderr}]
             [-o {all,none,stdout,stderr}]
             [-t {all,system-summary,processes-samples}]
-            command [arguments ...]
+            command ...
 
 Gathers metrics on a command and all its child processes.
 
 positional arguments:
   command               The command to execute.
-  arguments             Arguments for the command. (default: None)
+  inner_args            Arguments for the command.
 
-options:
+optional arguments:
   -h, --help            show this help message and exit
+  --version             show program's version number and exit
   -p OUTPUT_PREFIX, --output-prefix OUTPUT_PREFIX
                         File string format to be used as a prefix for the
                         files -- the captured stdout and stderr and the
@@ -50,6 +53,7 @@ options:
   -t {all,system-summary,processes-samples}, --record-types {all,system-summary,processes-samples}
                         Record system-summary, processes-samples, or all
                         (default: all)
+<!--- END HELP -->
 ```
 
 ## Testing: