diff --git a/packages/@sanity/core/src/commands/start/startCommand.js b/packages/@sanity/core/src/commands/start/startCommand.js index 425ed84b352..8f5bb3a624f 100644 --- a/packages/@sanity/core/src/commands/start/startCommand.js +++ b/packages/@sanity/core/src/commands/start/startCommand.js @@ -1,8 +1,22 @@ import lazyRequire from '@sanity/util/lib/lazyRequire' +const helpText = ` +Notes + Changing the hostname or port number might require a new CORS-entry to be added. + +Options + --port TCP port to start server on. [default: 3333] + --host The local network interface at which to listen. [default: "127.0.0.1"] + +Examples + sanity start --host=0.0.0.0 + sanity start --port=1942 +` + export default { name: 'start', - signature: '', + signature: '[--port ] [--host ]', description: 'Starts a webserver that serves Sanity', - action: lazyRequire(require.resolve('../../actions/start/startAction')) + action: lazyRequire(require.resolve('../../actions/start/startAction')), + helpText }