Skip to content

Install ​

Install gform, get a browser ready, then run your first form.

Requirements ​

RequirementNotes
Node.js ≥ 20From package engines
Chromium-family browserPlaywright Chromium for runs; prefer system Chrome for Google sign-in
NetworkLive inspect / verify --check / run need access to Google Forms

Published package ​

bash
pnpm add -g gform
# or
npm i -g gform

pnpm exec playwright install chromium

Confirm:

bash
gform version
# or
gform -V

From this repository ​

bash
pnpm install
pnpm exec playwright install chromium
pnpm build
pnpm i -g .

Dev without a global install:

bash
pnpm gform -- --help
pnpm gform -- list

Data home ​

Default library and artifacts:

text
~/.local/share/gform/

Overrides:

bash
export GFORM_HOME=/custom/gform
# or
export XDG_DATA_HOME=/custom/xdg   # → $XDG_DATA_HOME/gform

See portable paths · platforms.

Browsers and WSL ​

  • gform browsers list — discovery and readiness
  • gform browsers setup chrome — host-aware install plan (Linux/WSL .deb)
  • gform doctor — disk + inventory; add --browser / --auth for live probes

On WSL, Windows Chrome under /mnt/c/… may show as found but is usually not CDP-controllable. Install Linux Chrome for auth and headed runs. Details: browsers · platform.

Next ​

  1. Guide — first form
  2. Concepts
  3. Schema