# Run and maintain Synq
URL: https://synquic.tech/docs/cli/run.md

Start a local installation, inspect it, and manage its lifecycle.

Use these commands on the machine that runs Synq. To manage an existing remote installation,
[configure a connection context](/docs/cli/access) instead.

## Start

```bash
synq
```

On a fresh machine, the interactive command guides setup. On an installed machine, it opens the
control panel or resumes an interrupted setup.

For direct startup:

```bash
synq up
synq status
synq open
```

`up` installs or starts a persistent service. `status` reports local service state and the active
context's API health. `open` opens the dashboard. Use `synq up --foreground` for an attached process.
See [all startup options](/docs/cli/reference/up), including Docker Compose configuration.

## Stop and update

```bash
synq stop           # on the server (sudo synq stop on a server installed with the installer)
```

`stop` disables the service so it stays stopped across reboot. To update, run the installer again with your
license key; it upgrades the CLI and the images together. Read [updating Synq](/docs/guides/updating) before
updating a production installation.

## Move the panel to a domain

```bash
synq panel-domain                                                # show the panel's address
synq panel-domain panel.example.com --email you@example.com      # serve the panel on https://panel.example.com
```

Run it as root on the server (`sudo`). It checks DNS, issues the certificate before anything moves, and returns the
panel to its old address if the new one doesn't come up. See
[Move the panel to a domain later](/docs/getting-started/installation#move-the-panel-to-a-domain-later).

## Diagnose a problem

```bash
synq doctor
```

The [doctor reference](/docs/cli/reference/doctor) describes health and repair options. Local admin
account recovery uses [reset-admin-password](/docs/cli/reference/reset-admin-password).

## Installation commands compared

| Command | Purpose |
| --- | --- |
| The installer (`curl -sSL https://synquic.tech/install.sh \| sh -s -- --key <KEY>`) | Install Synq on a server, or upgrade it (see [installation](/docs/getting-started/installation)). |
| `synq up` | Start the Synq API and dashboard as a service on this machine. |
| `synq panel-domain` | Show the panel's address, or move the panel to your own domain with a certificate. |
| `synq stop` | Stop the service; it stays stopped across reboots. |
| `synq status` | Show the service state, its ports, and the API's health. |
| `synq uninstall` | Remove local installation state and data; deployed apps are left running. |

See [installation](/docs/getting-started/installation) for server requirements and
[command options](/docs/cli/reference#local-installation) before removing or repairing an installation.