Warning

This version of the documentation is NOT an official release. You are reading the documentation version which is in active and ongoing development. You can change versions on the bottom left of the screen.

Command API

This documentation guide provides detailed information about the command nest-desktop.

Show the usage of the nest-desktop command:

nest-desktop

Options for nest-desktop:

nest-desktop status|start|stop|restart [-h <HOST>] [-p <PORT>]

Commands

status

display the status of NEST Desktop

start

start a new server instance for NEST Desktop

stop

stop a server instance running on <HOST>:<PORT>

restart

restart (i.e. stop and start) a server on <HOST>:<PORT>

Arguments

-h <HOST>

use hostname/IP address <HOST> for the server [default: 127.0.0.1]

-p <PORT>

use port <PORT> for opening the socket [default: 8000]


Environment variables

You can set environment variables for host and port before you start NEST Desktop.

export NEST_DESKTOP_HOST="0.0.0.0"
export NEST_DESKTOP_PORT=8000

nest-desktop start