Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[core] Add help text for sanity start command #183

Merged
merged 1 commit into from
Sep 19, 2017
Merged

[core] Add help text for sanity start command #183

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions packages/@sanity/core/src/commands/start/startCommand.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <port> TCP port to start server on. [default: 3333]
--host <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 <port>] [--host <host>]',
description: 'Starts a webserver that serves Sanity',
action: lazyRequire(require.resolve('../../actions/start/startAction'))
action: lazyRequire(require.resolve('../../actions/start/startAction')),
helpText
}