Skip to main content

datacontract edit

Edit a data contract file in the Data Contract Editor (web UI). Starts a local web server that opens the editor for the given file; saving writes back to the local file. Requires the api extra.

datacontract edit [LOCATION]
ArgumentDefaultDescription
LOCATIONdatacontract.yamlPath of the data contract YAML to edit. If it does not exist, you are asked whether to initialize a new one. If a URL is given, you are asked whether to download a local copy.
OptionDefaultDescription
--port4243Bind the server to this port.
--host127.0.0.1Bind to this host (use 0.0.0.0 for Docker).
--editor-versionbundledVersion of the datacontract-editor npm package to load from the CDN.
--editor-assets-urlBase URL for editor assets (takes precedence over --editor-version).
--open / --no-open--openOpen the editor in the default browser.
--debug / --no-debug--no-debugEnable debug logging.
datacontract edit datacontract.yaml

See the Data Contract Editor guide for details.