2.2 KiB
2.2 KiB
Yaml Editor
What is Yaml Editor?
Yaml Editor is a spyglass utility which lets user edit their
generated intermediary file in a browser window. It is a minimal flask
app which is invoked from the parser engine in order to let user edit
fields which could not be fetched via tugboatinfo
plugin.
Yaml Editor Utility Inputs
- Yaml File: Yaml file required to be edited (This is required field)
- Port: Port on which app shall be running
- Host: This is only used to form URL which can be followed to open file in browser
- String: String which is required to be updated in the file (default is '#CHANGE_ME')
Yaml Editor Utility Usage
With Spyglass (edit option is True by default): :
spyglass -mg --edit_intermediary -t tugboat -x SiteDesignSpec_v0.1.xlsx -e excel_spec_upstream.yaml -d site_config.yaml -s airship-seaworthy --template_dir=<relative path to '../examples/templates'
As a stand-alone editor: :
yaml-editor -f <yaml-file>
Help: :
> yaml-editor --help Usage: yaml-editor [OPTIONS] Options: -f, --file FILENAME Path with file name to the intermediary yaml file. [required] -h, --host TEXT Optional host parameter to run Flask on. -p, --port INTEGER Optional port parameter to run Flask on. -s, --string TEXT Text which is required to be changed on yaml file. --help Show this message and exit.