Add example of --help

lunarmodules · Dec 13, 2023 · 222e104 · 222e104
1 parent 538417a
commit 222e104
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/examples/05_help.lua b/examples/05_help.lua
@@ -0,0 +1,21 @@
+#!/usr/bin/lua
+
+--[[
+Shows how to use the builtin help functions to create a -h/--help option.
+--]]
+
+local cli = require "cliargs"
+
+function help()
+ cli:print_help()
+ os.exit(0)
+end
+
+cli:flag("-h, --help", "prints the help and usage text", help)
+
+local args, err = cli:parse()
+
+if not args then
+ print(err)
+ os.exit(1)
+end