> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/Crosstalk-Solutions/project-nomad/llms.txt
> Use this file to discover all available pages before exploring further.

# Helper Scripts

> Command-line scripts for starting, stopping, updating, and uninstalling N.O.M.A.D. when the web interface is unavailable.

After installation, N.O.M.A.D. places a set of helper scripts in `/opt/project-nomad`. These scripts let you perform maintenance operations directly from the terminal — useful when you can't reach the web interface or need to script automated tasks.

## Scripts overview

| Script               | Command                                        | What it does                                                                                     |
| -------------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| `start_nomad.sh`     | `sudo bash /opt/project-nomad/start_nomad.sh`  | Starts all installed N.O.M.A.D. containers                                                       |
| `stop_nomad.sh`      | `sudo bash /opt/project-nomad/stop_nomad.sh`   | Stops all running N.O.M.A.D. containers                                                          |
| `update_nomad.sh`    | `sudo bash /opt/project-nomad/update_nomad.sh` | Pulls the latest images for the Command Center and its dependencies and recreates the containers |
| `uninstall_nomad.sh` | See uninstall section below                    | Completely removes N.O.M.A.D. from the system                                                    |

## start\_nomad.sh

Starts all containers whose names begin with `nomad_` — including both the Command Center and any installed app containers.

```bash theme={null}
sudo bash /opt/project-nomad/start_nomad.sh
```

The script finds all N.O.M.A.D. containers (running or stopped) and starts each one in sequence, reporting success or failure for each.

**When to use it:** If the server was shut down without going through the Command Center, or if containers were stopped manually, run this script to bring everything back up.

<Note>
  N.O.M.A.D. is configured to start automatically when the host system boots. You only need this script if containers were stopped manually or if auto-start failed.
</Note>

## stop\_nomad.sh

Gracefully stops all currently running N.O.M.A.D. containers.

```bash theme={null}
sudo bash /opt/project-nomad/stop_nomad.sh
```

The script finds all running containers with names beginning with `nomad_` and sends a graceful stop signal to each one.

**When to use it:** Before performing host system maintenance, before shutting down the server, or when you need to stop all services at once from the command line.

## update\_nomad.sh

Updates the N.O.M.A.D. Command Center and its core dependencies (for example, the database) by pulling the latest Docker images and recreating the containers.

```bash theme={null}
sudo bash /opt/project-nomad/update_nomad.sh
```

The script will:

1. Verify prerequisites (Debian-based OS, bash, sudo, Docker, Docker Compose v2)
2. Prompt for confirmation before proceeding
3. Pull the latest images defined in `/opt/project-nomad/compose.yml`
4. Force-recreate the Command Center containers with the new images

<Warning>
  This script updates the **Command Center only** — it does not update installable app containers (AI Assistant, Kiwix, Kolibri, etc.). Update those through **Settings → Apps** in the web interface.
</Warning>

**When to use it:** Use this as an alternative to the web-based update when the Command Center itself is not accessible or when you prefer command-line control.

## uninstall\_nomad.sh

<Warning>
  Uninstallation **cannot be undone**. All containers, networks, and optionally all stored data will be permanently deleted.
</Warning>

The uninstall script is not bundled in `/opt/project-nomad` by default — download it fresh to ensure you have the latest version:

```bash theme={null}
curl -fsSL https://raw.githubusercontent.com/Crosstalk-Solutions/project-nomad/refs/heads/main/install/uninstall_nomad.sh -o uninstall_nomad.sh
sudo bash uninstall_nomad.sh
```

The script will:

1. Verify prerequisites and confirm you are not running from `/opt/project-nomad`
2. Prompt for confirmation before proceeding
3. Stop and remove the Command Center containers (`docker compose down`)
4. Stop and remove all `nomad_*` app containers
5. Remove the shared Docker network and update volume
6. Optionally delete the `/opt/project-nomad` directory and all stored data

When prompted about deleting the storage directory, choose:

* **Yes** — complete removal, suitable for a fresh reinstall. All downloaded content (ZIM files, models, maps) is deleted.
* **No** — containers and images are removed, but files in `/opt/project-nomad` are preserved.

**When to use it:** Starting fresh on the same hardware, decommissioning the server, or troubleshooting an installation that can't be recovered.

## When to use scripts vs. the web interface

| Situation                     | Recommended approach                                              |
| ----------------------------- | ----------------------------------------------------------------- |
| Normal day-to-day management  | Web interface (Settings → Apps)                                   |
| Update installed apps         | Web interface (Settings → Apps)                                   |
| Update the Command Center     | Web interface (Settings → Check for Updates) or `update_nomad.sh` |
| Command Center is unreachable | `start_nomad.sh` to bring it back up                              |
| Pre-maintenance shutdown      | `stop_nomad.sh`                                                   |
| Scripted/automated operations | Helper scripts                                                    |
| Complete removal              | `uninstall_nomad.sh`                                              |

## Related

<CardGroup cols={2}>
  <Card title="Apps Manager" icon="grid-2" href="/management/apps">
    Manage and update installed tools from the web interface.
  </Card>

  <Card title="Updates" icon="rotate" href="/management/updates">
    Update the Command Center software from the web interface.
  </Card>

  <Card title="System Health" icon="heart-pulse" href="/management/system-health">
    Monitor server status and service logs.
  </Card>
</CardGroup>