Skip to content
This repository was archived by the owner on Sep 10, 2026. It is now read-only.

README.md

Latest commit

 

History

History
122 lines (90 loc) · 3.41 KB

README.md

File metadata and controls

122 lines (90 loc) · 3.41 KB
Raw

webform

Dynamic web form for collecting structured data from users. AI generates a compact schema, opens a browser form, and receives the submitted data as JSON.

The Problem

Terminal prompts are fine for simple inputs, but collecting complex, multi-field, or sensitive data (passwords, API keys) is clunky. Filling a browser form is often faster and less error-prone.

The Solution

webform opens a real web form in the browser. The AI describes what it needs as a compact schema, and the user fills it out with proper UI controls — dropdowns, checkboxes, password fields, file uploads, and more.

Quick Start

# Install CLI
curl -fsSL https://raw.githubusercontent.com/bang9/ai-tools/main/webform/install.sh | bash

# Open a form
webform <<'EOF'
form "API Config"
key pw "API Key" req
env sel "Environment" req o=[dev,staging,prod]
EOF

Plugin

Installs the webform CLI automatically in Claude Code sessions:

/plugin marketplace add bang9/ai-tools
/plugin install webform

Commands

Command Description
webform Read schema from stdin, open form, print result
webform schema Print schema format reference
webform --timeout N Set timeout in seconds (default: 300)
webform version Print version
webform upgrade Update to latest version

Schema Format

Preferred input is the DSL shown by webform schema. JSON still works as a fallback.

form "Title" [desc="Description"] [timeout=120]
<name> <type> "<label>" [opts...]

Field types:

Code Type Code Type Code Type
t text pw password ta textarea
n number sel select msel multiselect
rad radio cb checkbox url url
email email tel tel date date
time time dt datetime color color
range range file file json json editor
list dynamic list grp field group

Common options:

Key Description Key Description
req required ph placeholder
def default value o options array
pat regex pattern min min value/length
max max value/length step step increment
rows textarea rows accept file accept types
it list item type io.ph list item placeholder
multi multiple files (file)

Need the full syntax and examples? Run webform schema.

Example

webform <<'EOF'
form "Deploy Config" timeout=120
env sel "Environment" req o=[dev,staging,prod]
key pw "API Key" req
endpoints list "Endpoints" it=url io.ph="https://..."
notify cb "Send notification"
EOF

Result:

{"status":"submitted","data":{"env":"prod","key":"sk-...","endpoints":["https://..."],"notify":true}}

Status values: submitted, cancelled, timeout

How It Works

  1. CLI reads a schema from stdin
  2. Starts a temporary local HTTP server on a random port
  3. Opens the form in the default browser
  4. User fills out and submits (or cancels / times out)
  5. Server prints result JSON to stdout and exits
  6. Browser tab auto-closes

Security: Each session uses a one-time token. Server binds to localhost only.

Build from Source

cd webform
make build    # Build CLI binary
make test     # Run tests
make cross    # Cross-compile for all platforms

License

MIT