---
id: applet-start-index
title: start
sidebar_position: 1013
---
# start

Start local applet development server with live preview


## Description

Starts a local development server with hot reload functionality, allowing developers
to preview their applets in a browser-based emulator. Supports both local development
and device connection for testing on actual signageOS devices.

:::tip Remarks
The development server provides a browser-based emulator accessible at http://localhost:8090
by default. Hot reload automatically refreshes the emulator when source code changes.
:::

## Usage

```bash
sos applet start [options]
```

## Options

| Option                      | Description                                                                                                                                               | Default |
| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| `--no-default-organization` | Prevent using the defaultOrganizationUid from ~/.sosrc (boolean)                                                                                          |         |
| `--organization-uid`        | Organization UID (string)                                                                                                                                 |         |
| `--port`                    | Port where will the applet run (number)                                                                                                                   | `8090`  |
| `--applet-path`             | Path to the applet file or the project folder depending on the entry file. Relative to the command or absolute. (string)                                  |         |
| `--entry-file-path`         | Path to the applet entry file. Relative to the command or absolute. (string)                                                                              |         |
| `--hot-reload`              | Enable hot reload and build of applet (boolean)                                                                                                           | `false` |
| `--server-port`             | The custom server port for local machine server. Default is detected from currently running applet server. (number)                                       |         |
| `--server-public-url`       | Public url of local machine server. Is useful when the local machine is behind a reverse proxy. (string)                                                  |         |
| `--force`                   | Force start applet server even if it is already running on a different port. Kill the running server first. (boolean)                                     |         |
| `--detach`                  | Detach the applet HTTP server process from the terminal. Useful when want to run more commands reusing the same http server for current applet. (boolean) | `false` |
| `--forward-server-url`      | Url of forward server to connect to the device instead of the local network (LAN). (string)                                                               |         |

## Examples

```bash
# Start development server with default settings
sos applet start

# Start with custom port and hot reload
sos applet start --port 8080 --hot-reload

# Start with specific organization
sos applet start --organization-uid abc123

# Start with custom applet path
sos applet start --applet-path ./my-applet

# Start with specific entry file
sos applet start --entry-file-path index.html

# Force restart if server is already running
sos applet start --force

# Run in detached mode
sos applet start --detach
```

## Since

0.1.0

## Global Options

All commands support the following global options:

| Option | Alias | Description |
|--------|-------|-------------|
| `--help` | `-h` | Display help information for any command |
| `--version` | `-v` | Display the installed version of the CLI |
| `--api-url` | `-u` | Override the API URL for REST requests |
| `--profile` | | Use a specific profile from ~/.sosrc config |

### Examples

```bash
# Show version
sos --version

# Get help for any command
sos applet --help
sos applet upload --help

# Use custom API endpoint
sos --api-url https://api.example.com applet upload

# Use specific profile
sos --profile production organization list
```


## See Also

- [Applet Development Documentation](https://developers.signageos.io/docs/applets/connect-to-device-cli/)