Form Building
Creating a Form
Use the create-form script to create forms from natural language:
pnpm action create-form --title "Contact Form" --fields '[...]'
The script generates a unique ID, creates a URL slug, and stores the form in SQL as draft status.
Field Types
| Type | Description | Options needed | Example use |
|---|---|---|---|
text |
Single-line text input | No | Name, company |
email |
Email input with validation | No | Contact email |
number |
Numeric input | No | Age, quantity |
textarea |
Multi-line text | No | Message, comments |
select |
Single-choice dropdown | Yes | Country, department |
multiselect |
Multi-choice dropdown | Yes | Skills, interests |
checkbox |
Boolean toggle | No | Consent, opt-in |
radio |
Single-choice radio buttons | Yes | Gender, preference |
date |
Date picker | No | Birthday, deadline |
rating |
Star rating (1-5) | No | Satisfaction, quality |
scale |
Numeric scale (e.g., 1-10) | No | NPS, likelihood |
file |
File upload | No | Resume, attachment |
Field JSON Schema
Each field is a JSON object:
{
"id": "field_name",
"type": "text",
"label": "Your Name",
"placeholder": "Enter your name",
"description": "Help text shown below the field",
"required": true,
"options": ["Option A", "Option B"],
"validation": {
"min": 1,
"max": 100,
"pattern": "^[a-zA-Z]+$",
"message": "Custom error message"
},
"conditional": {
"fieldId": "other_field_id",
"operator": "equals",
"value": "show_this_field"
},
"width": "full"
}
Required properties
id— unique identifier (snake_case recommended)type— one of the types abovelabel— display labelrequired— boolean
Always pass fields as these complete objects. Never encode a field as shorthand
text such as text: Enter a name; patch-form-fields upserts also require the
field id so they cannot be ambiguous.
Optional properties
placeholder— input placeholder textdescription— help text below the fieldoptions— array of strings (required for select, multiselect, radio)validation— min/max/pattern/message for custom validationconditional— show field only when another field matches a conditionwidth—"full"(default) or"half"for side-by-side layoutmultiple,accept,maxSizeBytes,maxFiles— file upload settings forfilefields
Updating a Form
Use update-form to modify any form property:
# Change title
pnpm action update-form --id <id> --title "New Title"
# Update fields
pnpm action update-form --id <id> --fields '[...]'
# Change status
pnpm action update-form --id <id> --status published
Common Form Templates
When a user asks for a common form type, use these field patterns:
Contact form:
[
{"id":"name","type":"text","label":"Name","required":true},
{"id":"email","type":"email","label":"Email","required":true},
{"id":"message","type":"textarea","label":"Message","required":true}
]
Survey/feedback:
[
{"id":"rating","type":"rating","label":"Overall satisfaction","required":true},
{"id":"recommend","type":"scale","label":"How likely to recommend? (1-10)","required":true},
{"id":"feedback","type":"textarea","label":"Additional feedback","required":false}
]
Registration/signup:
[
{"id":"first_name","type":"text","label":"First Name","required":true,"width":"half"},
{"id":"last_name","type":"text","label":"Last Name","required":true,"width":"half"},
{"id":"email","type":"email","label":"Email","required":true},
{"id":"role","type":"select","label":"Role","options":["Student","Professional","Other"],"required":true}
]
Workflow
create-formwith title and fields- Preview in the GUI (agent + user iterate)
update-form --status publishedto go live- Share the public URL:
/f/<slug>
Related Skills
- form-responses — Viewing and analyzing submitted data
- form-publishing — Form lifecycle (draft -> published -> closed)
- scripts — All form operations go through scripts