help

Show CLI help for gform and individual commands. Supplements --help with workflows, examples, and doc links.

basic usage

gform help
gform --help                          # same top-level help
gform help run
gform help auth create
gform help run list
gform help clean artifacts

Topic aliases resolve the same as real commands (ls → list, v → view under run).

what's in command help

Beyond Commander's Options/Arguments, each command appends:

section	content
Workflows	common operator paths in one line each
Examples	copy-paste gform … invocations
Related	sibling commands to try next
Notes	gotchas (live panel, list limits, reserved names)
Documentation	link to the docs site command page

gform help run
# … Options …
# Workflows:
#   Single run              run <form>
#   Repeat + workers        run <form> -r 10 -C 5
# …
# Documentation: https://thegform.pages.dev/commands/run

global flags (all commands)

These apply everywhere and appear under Global Options:

gform -d                            # debug
gform -j                            # JSON output
gform -T 5                          # list row limit
gform -F                            # full lists
gform -nl                           # no live panel (with run)
gform -q / -s                       # quiet / silent

Multi-char shorts (-jp, -nlc, -nlp, -nb) and command aliases (ls, rm, ver, br, …) expand before parsing — gform help run documents the canonical long forms.

command aliases

alias	command
ls	list
v	view (form config; run v → run view for artifacts)
rm	delete
ver	verify
insp	inspect
pol	policies
ren	rename
br	browsers
rs	restore
run ls	run list
run v	run view
run rm	run delete
browsers ls / br ls	browsers list
browsers chk / def / set	check / default / setup
auth ls / v / rm / ver	list / view / delete / verify
auth cre / act	create / activate
clean art / hist	artifacts / history

online docs

This folder (docs/commands/) mirrors the published site. Start at commands index, the install page, or the guide.

gotchas

• Prefer gform help <command> over <command> --help for commands with optional positionals (verify, init, inspect, …) — Commander can treat --help as the target argument today.
• gform help with no topic prints root help (all top-level commands).
• Parent commands (auth, browsers, clean, run) show subcommands — drill into help auth create for detail.
• Documentation URLs in help point at thegform.pages.dev — same content as local docs/commands/*.md.
• For narrative guides (auth session story, artifacts layout), use the topic pages linked from each command doc.

related

• commands index — all command pages
• guide.md — day-to-day overview
• run.md — most-used command