You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
wpetit e587d00265 Merge branch 'release/0.0.6' 2 months ago
.chglog chore: add release preparation tasks with changelog generation 4 months ago
.githooks chore: tailwindcss theme + goreleaser basic recipe 7 months ago
.github/workflows chore: add basic github workflows 7 months ago
cmd/frmd feat: use --debug flag for error more verbose output 2 months ago
internal feat: aggregate defaults and values 2 months ago
misc feat(install): fix script execution on alpine 5 months ago
.env.dist chore: use .env file in make tasks 7 months ago
.gitignore chore: add release preparation tasks with changelog generation 4 months ago
.goreleaser.yaml chore: generate assets before release 7 months ago
CHANGELOG.md chore: update changelog for version 0.0.6 2 months ago
Makefile chore: fix start-release task 2 months ago
README.md feat: add null:// update handler 2 months ago
commitlint.config.js chore: tailwindcss theme + goreleaser basic recipe 7 months ago
go.mod feat: aggregate defaults and values 2 months ago
go.sum feat: aggregate defaults and values 2 months ago
modd.conf chore: disable install script tests in watch mode 2 months ago
package-lock.json feat: aggregate defaults and values 2 months ago
package.json chore: bump to version 0.0.6 2 months ago
tailwind.config.js chore: tailwindcss theme + goreleaser basic recipe 7 months ago

README.md

Formidable

Web-based - but terminal compatible ! - little form editor using JSONSchema models.

Terminal compatible ?

The generated web UI does not use Javascript and can be used with terminal browsers like w3m or lynx.

⚠ Formidable is currently in a very alpha stage ! Expect breaking changes...

Install

Manually

Download the pre-compiled binaries from the releases page and copy them to the desired location.

Bash script

curl -sfL https://raw.githubusercontent.com/Bornholm/formidable/master/misc/script/install.sh | bash

It will download frmd to your current directory.

Install script environment variables

Name Description Default
FORMIDABLE_VERSION Formidable version to download latest
FORMIDABLE_DESTDIR Formidable destination directory .

URLs

Formidable uses URLs to define how to handle schemas/defaults/values.

For example, to edit with Firefox a schema (in YAML) from an HTTPS server, while readig default values from stdin (in JSON) and using effective values from the local file system (in HCL), outputing updates to stdout:

echo '{}' | FORMIDABLE_BROWSER="firefox" frmd \
    edit
    --schema 'https://example.com/my-schema.yml' \
    --defaults 'stdin://local?format=json' \
    --values 'file:///my/file/absolute/path.hcl' \
    --output 'stdout://local?format=json'

Available loaders

stdin://

TODO: Write doc + example

http:// and https://

TODO: Write doc + example

file://

TODO: Write doc + example

Available formats

JSON

  • URL Query: ?format=json
  • File extension: .json
  • As input: yes
  • As output: yes

YAML

  • URL Query: ?format=yaml
  • File extension: .yaml or .yml
  • As input: yes
  • As output: yes

HCL

  • URL Query: ?format=hcl
  • File extension: .hcl
  • As input: yes
  • As output: no

Available outputs

stdout:// (default)

TODO: Write doc + example

null://

TODO: Write doc + example

file://

TODO: Write doc + example

exec://

TODO: Write doc + example

Changelog

See CHANGELOG.md

Licence

AGPL-3.0