Skip to content

doctor (command) ​

Host health check — layout, browsers, library, and saved auth metadata. Fast by default; optional live probes.

For full semantics of each check and exit codes, see doctor.md.

quick check (default) ​

bash
gform doctor
gform doctor --json

Reads disk only — no browser, no Google requests:

  • Node + Playwright versions, $GFORM_HOME writable
  • layout dirs (forms, artifacts, auth, browsers, history)
  • library form count + last history row
  • browser inventory (ready / found / missing, ★ default)
  • auth profiles with last saved verify status

Exit code 1 if structural issues are found.

live browser probe ​

bash
gform doctor --browser
gform doctor --browser chrome

Headless launch+close (same as gform browsers check). No id → uses browsers default, else first ready target.

Fails with a fix hint (gform browsers setup <id>) when launch breaks.

live auth verify ​

bash
gform doctor --auth
gform doctor --auth --headless
gform doctor --auth --browser --headless

Runs auth verify for every profile — updates meta.json with fresh verdicts.

outcomedoctor treats as
okpass
invaliderror — recreate profile
inconclusivewarning — retry, not logout

Combine with --browser when debugging auth + launch together.

when to run doctor ​

situationflags
fresh install / new machinegform doctor
auth create keeps failinggform doctor --browser
--auth runs suddenly failgform doctor --auth
CI preflightgform doctor --json
after gform cleangform doctor

gotchas ​

  • Default doctor does not hit the network — saved invalid may be stale until --auth.
  • --auth opens a browser per profile (headed unless --headless).
  • Browser probe failure does not auto-fix — follow setup hints.
  • JSON output includes the full issues[] array for scripting.