> For the complete documentation index, see [llms.txt](https://www.opal-rt.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.opal-rt.com/docs/rt-lab/automation-api-and-scripting/introduction-to-automation/launch-the-metacontroller.md).

# Launch the MetaController

## Overview

**The MetaController is a background service that runs on the host computer as part of RT‑LAB.** It is typically launched automatically when the main RT‑LAB user interface starts, but it can also be started manually or through scripting.

The primary role of the MetaController is to **manage RT‑LAB background processes**, particularly the **Controller.exe** instances that are created when projects are opened. It also oversees the **OpalDLoader** executable, which is automatically started when the MetaController initializes and terminated when it shuts down.

The MetaController is a **critical component** for the proper operation of both RT‑LAB and its API. It must be running whenever RT‑LAB or its API is in use. Additionally, it is important that the MetaController **is not stopped or restarted while other RT‑LAB processes** (such as RT-LAB.exe or Controller.exe) are active, as this may lead to instability or unexpected behavior.

## Start the MetaController

When the user does not intend to use the RT‑LAB UI and instead relies on the API to control simulations, the MetaController must be started manually, via a program, or through scripting. This initialization must be completed before making any API calls.

{% columns %}
{% column %}
The **MetaController executable** is typically located at “\<RT-LAB Installation path>\common\bin\MetaController.exe”, unless a different path was specified during the installation of RT-LAB.
{% endcolumn %}

{% column valign="middle" %}

<figure><img src="https://96827845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNRdpSk8kjn20gXAexnt6%2Fuploads%2Fgit-blob-4d57cf52837ce599fd6dd2929c6b5e43fbe4e785%2FMetaController.png?alt=media" alt=""><figcaption></figcaption></figure>
{% endcolumn %}
{% endcolumns %}

{% hint style="info" %}
Whenever the MetaController is started manually or from a script, it is primordial to ensure the MetaController executable from the correct RT-LAB version is used.
{% endhint %}

### Command line options

When launching the MetaController through command line or programmatically, the following options can be passed as arguments (Windows only):

<table><thead><tr><th width="140.2222900390625">Argument</th><th>Description</th></tr></thead><tbody><tr><td><strong>-noUI</strong></td><td><p>Disables the creation of icon in the system tray and GUI for the MetaController.</p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>Using this option is essential when RT-LAB is to be used in a fully automated context, such as continuous integration, where RT-LAB executes in a OS environment without graphical interface. Not using this option in this context may result in unpredictable behavior.</p></div></td></tr><tr><td><strong>-launchUI</strong></td><td>After completing its launch, the MetaController will automatically launch the main RT-LAB UI. It should not be combined with the -noUI option.</td></tr></tbody></table>

## Close the MetaController

If the MetaController is started via a script or a program, it can be stopped by invoking the **OpalCloseMetaController** API call.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://www.opal-rt.com/docs/rt-lab/automation-api-and-scripting/introduction-to-automation/launch-the-metacontroller.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
