Skip to content

About

FormFlow command line: forms, config as code, experiments, exports

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

3 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

@formizeflow/cli

CI

The formflow command line for FormFlow. Built on @formizeflow/sdk; no other dependencies. Node 20+.

npm i -g @formizeflow/cli
export FORMFLOW_API_KEY=ff_...      # or: formflow login --key ff_...
formflow whoami

Config: FORMFLOW_API_KEY and FORMFLOW_URL (default https://formize.net), or formflow login, which writes ~/.config/formflow-cli/config.json (mode 0600). Keys are never printed, except by keys create, which shows the new key once.

Command What it does
whoami Workspace, role and server for the current key
forms ls, forms get <id|slug> List or show forms
forms pull <id> [file] Save the draft definition to a file
forms push <file> Upsert by slug (PUT /forms/by-slug); the file is a definition or {slug, name, definition, publish}
forms publish <id> [--force] Publish the draft
apply [formflow.json] [--plan] Config as code; prints create/update/unchanged, --plan stops there
experiments ls, experiments results <id> Experiments and their results
submissions export <formId> [--format csv|json] [--out file] Export responses
keys create --name N --scopes a,b [--workspace ws_] Create an API key
decide --entry E --uid U [--sig S] Ask the onboarding decision API
webhooks verify --secret-env VAR --signature SIG --body-file F Exit 0 if valid, 1 if not
openapi [--out file] Fetch the OpenAPI document

Every command takes --json; --help and --version work anywhere.

formflow.json

{
  "forms": [
    { "slug": "welcome", "file": "forms/welcome.json", "publish": true },
    { "slug": "nps", "name": "NPS", "definition": { "title": "NPS", "sections": [] } }
  ],
  "experiments": [
    { "entrySlug": "welcome-test", "form": "welcome", "name": "Headline test", "variants": [] }
  ]
}

Forms apply first (PUT /forms/by-slug), then experiments (PUT /experiments/by-entry); an experiment's form is a slug from the file or an existing form (or use formId). Re-running with no changes does nothing.

About

FormFlow command line: forms, config as code, experiments, exports

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages