Eclipse Theia

https://eclipse-theia.github.io/theia/docs/next
Admin
Eclipse Theia is an extensible IDE platform built with TypeScript that supports AI integrations,...
Tokens:2,991,204
Snippets:37,264
Trust Score:9.7
Update:18 hours ago
Show doc for...
Tokens:
Raw
### Build and run the browser example

Source: https://eclipse-theia.github.io/theia/docs/next/documents/Developing.html

Clones the Theia repository, installs dependencies, builds the browser example, downloads plugins, and starts the development server. After running, open http://localhost:3000 in your browser.

```bash
git clone https://github.com/eclipse-theia/theia \
    && cd theia \
    && npm install \
    && npm run build:browser \
    && npm run download:plugins \
    && npm run start:browser
```

--------------------------------

### Run the browser example with SSL

Source: https://eclipse-theia.github.io/theia/docs/next/documents/Developing.html

Clones the Theia repository, installs dependencies, downloads plugins, builds the browser example, and starts it with SSL using the provided certificate and key paths. After running, open https://localhost:3000 in your browser.

```bash
git clone https://github.com/eclipse-theia/theia \
    && cd theia \
    && npm install \
    && npm run download:plugins \
    && npm run build:browser \
    && npm run start:browser -- -- --ssl --cert /path/to/cert.crt --certkey /path/to/certkey.key
```

--------------------------------

### Build and run the Electron example

Source: https://eclipse-theia.github.io/theia/docs/next/documents/Developing.html

Clones the Theia repository, installs dependencies, builds the Electron example, downloads plugins, and starts the Electron application.

```bash
git clone https://github.com/eclipse-theia/theia \
    && cd theia \
    && npm install \
    && npm run build:electron \
    && npm run download:plugins \
    && npm run start:electron
```

--------------------------------

### Run Electron Example Application with npm run start:electron

Source: https://eclipse-theia.github.io/theia/docs/next/documents/Developing.html

Starts the Electron-based example application.

```bash
npm run start:electron
```

--------------------------------

### Run Browser Example Application with npm run start

Source: https://eclipse-theia.github.io/theia/docs/next/documents/Developing.html

Starts the backend application listening on port 3000. The frontend should be available at http://localhost:3000.

```bash
npm run start
```

--------------------------------

### getStartCommand(port?, debugConfig?)

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-dev.node_hosted-instance-manager.AbstractHostedInstanceManager.html

Protected method to get the start command for the hosted instance.

```APIDOC
## getStartCommand(port?, debugConfig?)

### Description
Protected method to get the start command.

### Method
getStartCommand

### Parameters
- **port** (number) - Optional - Port number
- **debugConfig** (PluginDebugConfiguration) - Optional - Debug configuration

### Returns
Promise<string[]>
```

--------------------------------

### Build example applications

Source: https://eclipse-theia.github.io/theia/docs/next/documents/Developing.html

Builds the browser and Electron example applications. Use 'npm run build:applications' to build all example applications at once.

```bash
npm run build:browser
npm run build:browser-only
npm run build:electron

# build all example applications at once:
npm run build:applications

```

--------------------------------

### install(options?)

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_vsx-registry.browser_vsx-extension.VSXExtension.html

Installs the extension with optional deployment options. Returns a promise that resolves when the installation is complete.

```APIDOC
## install(options?)

### Description
Installs the extension.

### Method
- install(options?: PluginDeployOptions): Promise<void>

### Parameters
- `Optional` options: PluginDeployOptions - Deployment options for the plugin.

### Returns
Promise<void>
```

--------------------------------

### didStart

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.hosted_common_hosted-plugin.AbstractHostedPluginSupport.html

Gets a promise that resolves when the initial plugins are started.

```APIDOC
## didStart

### Description
Resolves when the initial plugins are started.

### Returns
Promise<void>
```

--------------------------------

### start()

Source: https://eclipse-theia.github.io/theia/docs/next/interfaces/_theia_ai-mcp-server.node_mcp-theia-server.MCPTheiaServer.html

Starts the MCP server with the given configuration. Returns a promise that resolves when the server has started.

```APIDOC
## start()

### Description
Start the MCP server with the given configuration.

### Method
start

### Returns
- **Promise<void>** - A promise that resolves when the server has started.
```

--------------------------------

### setupRemoteConnection

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_dev-container.electron-node_remote-container-connection-provider.DevContainerConnectionProvider.html

Creates a remote connection, runs setup (injecting the Theia backend into the container), registers the connection, and starts a local proxy server.

```APIDOC
## setupRemoteConnection

### Description
Creates a remote connection, runs setup (injecting the Theia backend into the container), registers the connection, and starts a local proxy server.

### Method
setupRemoteConnection

### Parameters
- **container** (Container) - Required - The container to connect to.
- **docker** (Dockerode) - Required - Docker connection to use.
- **config** (DevContainerConfiguration) - Required - The dev container configuration.
- **nodeDownloadTemplate** (undefined | string) - Required - Template for downloading Node.js.
- **report** (RemoteStatusReport) - Required - Status report for the remote connection.
- **additionalArgs** (string[]) - Optional - Additional arguments.

### Returns
Promise<{ localPort: number; remote: RemoteDockerContainerConnection }> - The local proxy port and the remote connection.
```

--------------------------------

### get onStart(): Event<IProcessStartEvent>

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_process.node_raw-process.RawProcess.html

Accessor that returns an event that fires when the process starts.

```APIDOC
## get onStart(): Event<IProcessStartEvent>

### Description
Returns an event that fires when the process starts.

### Returns
Event<IProcessStartEvent>
```

--------------------------------

### start(serverModule)

Source: https://eclipse-theia.github.io/theia/docs/next/functions/_theia_core.node_main.start.html

The start function initializes the server with the provided server module and returns a promise that resolves to the address information of the started server.

```APIDOC
## Function start

### Description
Starts the server with the given server module and returns the address information.

### Signature
start(serverModule: MaybePromise<Server<typeof IncomingMessage, typeof ServerResponse>>): Promise<AddressInfo>

### Parameters
- **serverModule** (MaybePromise<Server<typeof IncomingMessage, typeof ServerResponse>>) - Required - The server module to start.

### Returns
Promise<AddressInfo> - A promise that resolves to the address information of the started server.

### Settings
- Member Visibility: Protected
- Inherited: Yes
- External: Yes
```

--------------------------------

### start(): Promise<void>

Source: https://eclipse-theia.github.io/theia/docs/next/interfaces/_theia_ai-copilot.node_copilot-sdk-types.CopilotClient.html

Starts the runtime and connects to it. Returns a promise that resolves when the runtime is started.

```APIDOC
## start(): Promise<void>

### Description
Starts the runtime and connects to it.

### Method
start

### Parameters
None

### Returns
Promise<void>
```

--------------------------------

### install

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_vsx-registry.browser_vsx-extension.AbstractVSXExtensionComponent.html

Installs the VSX extension. Optionally accepts a mouse event that triggered the install.

```APIDOC
## install

### Description
Installs the VSX extension. Optionally accepts a mouse event that triggered the install.

### Method
install

### Signature
install(event?: MouseEvent<Element, MouseEvent>): Promise<void>

### Parameters
- **event** (MouseEvent<Element, MouseEvent>) - Optional - The mouse event that triggered the install.

### Returns
Promise<void>
```

--------------------------------

### start

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_core.electron-main_electron-main-application.ElectronMainApplication.html

Starts the Electron main application with the provided frontend configuration. This method returns a promise that resolves when the application has started.

```APIDOC
## start

### Description
Starts the Electron main application with the provided frontend configuration.

### Method
start

### Signature
start(config: FrontendApplicationConfig): Promise<void>

### Parameters
- **config** (FrontendApplicationConfig) - Required - The frontend application configuration.

### Returns
Promise<void>
```

--------------------------------

### install

Source: https://eclipse-theia.github.io/theia/docs/next/interfaces/_theia_ai-registry.browser_mcp_mcp-install-service.MCPInstallService.html

Installs a registry entry, applying any user-supplied overrides collected by the install dialog.

```APIDOC
## install

### Description
Installs a registry entry, applying any user-supplied overrides collected by the install dialog.

### Method
install

### Parameters
- **entry** (ResolvedRegistryEntry) - Required - The registry entry to install.
- **overrides** (MCPInstallOverrides) - Optional - User-supplied overrides.

### Returns
Promise<void>
```

--------------------------------

### install(entry, options): Promise<boolean>

Source: https://eclipse-theia.github.io/theia/docs/next/interfaces/_theia_ai-registry.browser_plugin_plugin-installer.PluginInstaller.html

Installs a plugin using the provided resolved plugin entry and installation options. Returns true if the plugin was installed, false if the user cancelled either dialog.

```APIDOC
## install(entry, options): Promise<boolean>

### Description
Installs a plugin using the provided resolved plugin entry and installation options. Returns true if the plugin was installed, false if the user cancelled either dialog.

### Method
install

### Parameters
- **entry** (ResolvedPluginEntry) - Required - The resolved plugin entry to install.
- **options** (PluginInstallOptions) - Required - Options for the installation.

### Returns
Promise<boolean> - true when the plugin was installed, false when the user cancelled either dialog.

```

--------------------------------

### start(): Promise<void>

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_debug.browser_view_debug-configuration-widget.DebugConfigurationWidget.html

Starts the debug configuration.

```APIDOC
## start(): Promise<void>

### Description
Starts the debug configuration.

### Method
start

### Returns
Promise<void>
```

--------------------------------

### start

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_debug.common_inline-debug-adapter.InlineDebugAdapter.html

Starts the debug adapter.

```APIDOC
## start

### Description
Starts the debug adapter.

### Method
start

### Returns
Promise<void>
```

--------------------------------

### start

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_core.browser_frontend-application.FrontendApplication.html

Starts the frontend application. This method orchestrates the startup sequence: starting contributions, attaching the shell, initializing the layout, and revealing the shell.

```APIDOC
## METHOD start

### Description
Starts the frontend application. The startup sequence includes: starting frontend contributions, attaching the application shell to the host element, initializing the application shell layout, and revealing the application shell if it was hidden by a startup indicator.

### Signature
`start(): Promise<void>`

### Returns
- **Promise<void>** - Resolves when the application has started.

```

--------------------------------

### get start(): Position

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.plugin_types-impl.Range.html

Gets the start position of the range.

```APIDOC
## get start(): Position

### Description
Gets the start position of the range.

### Method
Accessor (get)

### Returns
Position
```

--------------------------------

### get installed()

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_vsx-registry.browser_vsx-extensions-model.VSXExtensionsModel.html

Returns an iterator over the IDs of all installed extensions.

```APIDOC
## GET installed

### Description
Returns an iterator over the IDs of all installed extensions.

### Returns
IterableIterator<string>
```

--------------------------------

### get start()

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.plugin_types-impl.Selection.html

Returns the start position of the selection, which is the position with the lesser offset.

```APIDOC
## [ACCESSOR] get start(): Position

### Description
Returns the start position of the selection, which is the position with the lesser offset.

### Returns
- **Position** - The start position.
```

--------------------------------

### setupInitialDisplay

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_preferences.browser_views_preference-scope-tabbar-widget.PreferencesScopeTabBar.html

Sets up the initial display.

```APIDOC
## setupInitialDisplay

### Description
Sets up the initial display.

### Method
Protected

### Returns
void
```

--------------------------------

### toggleView()

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_getting-started.browser_getting-started-contribution.GettingStartedContribution.html

Toggles the visibility of the Getting Started view.

```APIDOC
## toggleView()

### Description
Toggles the visibility of the Getting Started view.

### Method
toggleView

### Returns
Promise<GettingStartedWidget>
```

--------------------------------

### $start

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext-headless.plugin_headless-plugin-manager.HeadlessPluginManagerExtImpl.html

Loads and activates plugins.

```APIDOC
## $start

### Description
Loads and activates plugins.

### Parameters
- params (PluginManagerStartParams) - Required - Parameters for starting the plugin manager.

### Returns
- Promise<void>
```

--------------------------------

### closeView()

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_getting-started.browser_getting-started-contribution.GettingStartedContribution.html

Closes the Getting Started view if it is open.

```APIDOC
## closeView()

### Description
Closes the Getting Started view if it is open.

### Method
closeView

### Returns
Promise<undefined | GettingStartedWidget>
```

--------------------------------

### Download plugins for example applications

Source: https://eclipse-theia.github.io/theia/docs/next/documents/Developing.html

Downloads plugins to be used with the example applications. Run this command from the Theia repository root.

```bash
npm run download:plugins
```

--------------------------------

### openReadme()

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_getting-started.browser_getting-started-contribution.GettingStartedContribution.html

Opens the README file in the Getting Started view.

```APIDOC
## openReadme()

### Description
Opens the README file in the Getting Started view.

### Method
openReadme

### Returns
Promise<void>
```

--------------------------------

### init

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_monaco.monaco-quick-input-service.MonacoQuickInputImplementation.html

Initializes the quick input service.

```APIDOC
## init

### Description
Initializes the quick input service.

### Returns
- **void**
```

--------------------------------

### willStart

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.hosted_common_hosted-plugin.AbstractHostedPluginSupport.html

Gets a promise that resolves when the initial plugins are loaded and about to be started.

```APIDOC
## willStart

### Description
Resolves when the initial plugins are loaded and about to be started.

### Returns
Promise<void>
```

--------------------------------

### tryGetWidget()

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_getting-started.browser_getting-started-contribution.GettingStartedContribution.html

Returns the Getting Started widget if it exists, otherwise undefined.

```APIDOC
## tryGetWidget()

### Description
Returns the Getting Started widget if it exists, otherwise undefined.

### Returns
undefined | GettingStartedWidget
```

--------------------------------

### start

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.main_node_plugin-deployer-impl.PluginDeployerImpl.html

Starts the plugin deployer. This method initializes the deployment process.

```APIDOC
## start

### Description
Starts the plugin deployer.

### Method
start

### Signature
start(): Promise<void>

### Parameters
None

### Returns
Promise<void> - A promise that resolves when the deployer has started.
```

--------------------------------

### get isEmpty(): boolean

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.plugin_types-impl.Range.html

Checks if the range is empty (start equals end).

```APIDOC
## get isEmpty(): boolean

### Description
Checks if the range is empty (start equals end).

### Method
Accessor (get)

### Returns
boolean
```

--------------------------------

### start

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-dev.browser_hosted-plugin-manager-client.HostedPluginManagerClient.html

Starts the hosted plugin instance with optional debug configuration.

```APIDOC
## Method start

### Description
Starts the hosted plugin instance.

### Parameters
- `debugConfig` (PluginDebugConfiguration) - Optional. Debug configuration.

### Returns
- `Promise<void>`
```

--------------------------------

### init

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_filesystem.browser-only_browser-only-filesystem-provider-server.BrowserOnlyFileSystemProviderServer.html

Initializes the filesystem.

```APIDOC
## init

### Description
Initializes the filesystem.

### Method
init

### Parameters
No parameters documented.
```

--------------------------------

### init(): void

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_filesystem.browser-only_browser-only-filesystem-provider-server.BrowserOnlyFileSystemProviderServer.html

Initializes the filesystem provider. This method is protected.

```APIDOC
## init(): void

### Description
Initializes the filesystem provider. This method is protected.

### Method
init

### Parameters
None

### Returns
void
```

--------------------------------

### openView(args?: Partial<OpenViewArguments>)

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_getting-started.browser_getting-started-contribution.GettingStartedContribution.html

Opens the Getting Started view with optional arguments.

```APIDOC
## openView(args?: Partial<OpenViewArguments>)

### Description
Opens the Getting Started view with optional arguments.

### Parameters
- **args** (Partial<OpenViewArguments>) - Optional - Arguments to customize the view opening.

### Returns
Promise<GettingStartedWidget>
```

--------------------------------

### get isNewAppInstall(): boolean

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.plugin_env.EnvExtImpl.html

Abstract getter accessor that returns whether this is a new application install.

```APIDOC
## GET isNewAppInstall

### Description
Returns whether this is a new application install.

### Accessor
`get isNewAppInstall(): boolean`

### Returns
- **boolean** - True if this is a new install, false otherwise.
```

--------------------------------

### getStartCommand

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-dev.node_hosted-instance-manager.NodeHostedPluginRunner.html

Protected method. Returns the start command for the hosted instance.

```APIDOC
## getStartCommand(port?, debugConfig?)

### Description
Protected method. Returns the start command for the hosted instance.

### Method
getStartCommand

### Signature
`getStartCommand(port?: number, debugConfig?: PluginDebugConfiguration): Promise<string[]>`

### Parameters
- **port** (number) - Optional
- **debugConfig** (PluginDebugConfiguration) - Optional

### Returns
`Promise<string[]>`
```

--------------------------------

### init(): void

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_notebook.browser_service_notebook-kernel-service.NotebookKernelService.html

Initializes the kernel service. This method is called to set up the service.

```APIDOC
## init(): void

### Description
Initializes the kernel service. This method is called to set up the service.

### Method
N/A (SDK method)

### Parameters
None

### Returns
- **void** - No return value.
```

--------------------------------

### listeners() usage example

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_process.node_dev-null-stream.DevNullStream.html

Shows how to use the listeners() method to get an array of listeners for a specific event. The example attaches a connection listener to a server and then inspects the listeners array, printing [ [Function] ].

```javascript
server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]
```

--------------------------------

### init(): void

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_core.common_preferences_defaults-preference-provider.DefaultsPreferenceProvider.html

Initializes the preference provider.

```APIDOC
## init(): void

### Description
Initializes the preference provider.

### Method
init

### Returns
void
```

--------------------------------

### Theia log message format example

Source: https://eclipse-theia.github.io/theia/docs/next/media/README.md

Example log message showing the logger name ('root') and log level ('INFO') at the start, optionally followed by child process name and process ID.

```text
root INFO [parcel-watcher: 10734] Started watching: /Users/captain.future/git/theia/CONTRIBUTING.md
^^^^ ^^^^  ^^^^^^^^^^^^^^^^^^^^^
```

--------------------------------

### getStartCommand

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-dev.node_hosted-instance-manager.ElectronNodeHostedPluginRunner.html

Protected method that returns the start command for the hosted instance.

```APIDOC
## getStartCommand(port?: number, debugConfig?: PluginDebugConfiguration)

### Description
Protected method.

### Parameters
- **port** (number) - Optional
- **debugConfig** (PluginDebugConfiguration) - Optional

### Returns
Promise<string[]>
```

--------------------------------

### renderHeader(): ReactNode

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_getting-started.browser_getting-started-widget.GettingStartedWidget.html

Protected method that renders the widget header, displaying the title `{applicationName} Getting Started`.

```APIDOC
## renderHeader(): ReactNode

### Description
Protected method that renders the widget header, displaying the title `{applicationName} Getting Started`.

### Method
renderHeader

### Returns
ReactNode
```

--------------------------------

### Install @theia/ext-scripts as devDependency

Source: https://eclipse-theia.github.io/theia/docs/next/media/README-2.md

Add @theia/ext-scripts to the devDependencies of your package. The version shown is an example and may differ.

```json
{
    "name": "@theia/myextension",
    "devDependencies": {
        "@theia/ext-scripts": "^0.1.1"
    }
}
```

--------------------------------

### doInit()

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_memory-inspector.browser_wrapper-widgets_memory-layout-widget.MemoryLayoutWidget.html

Protected method for initialization.

```APIDOC
## doInit()

### Description
Protected method for initialization.

### Returns
Promise<void>

```

--------------------------------

### Example of process.execPath

Source: https://eclipse-theia.github.io/theia/docs/next/interfaces/_theia_core.electron-main_electron-main-application.ElectronMainProcessArgv.ElectronMainProcess.html

Shows the output of process.execPath, which returns the absolute pathname of the executable that started the Node.js process.

```bash
'/usr/local/bin/node'
```

--------------------------------

### cwd example: get current directory

Source: https://eclipse-theia.github.io/theia/docs/next/interfaces/_theia_core.electron-main_electron-main-application.ElectronMainProcessArgv.ElectronMainProcess.html

Uses process.cwd() to return the current working directory of the Node.js process.

```javascript
import { cwd } from 'node:process';

console.log(`Current directory: ${cwd()}`);
```

--------------------------------

### $start(params: PluginManagerStartParams): Promise<void>

Source: https://eclipse-theia.github.io/theia/docs/next/interfaces/_theia_plugin-ext.common_plugin-api-rpc.AbstractPluginManagerExt.html

Loads and activates plugins. This method is part of the plugin manager extension interface.

```APIDOC
## $start(params: PluginManagerStartParams): Promise<void>

### Description
Loads and activates plugins.

### Method
$start

### Parameters
- **params** (PluginManagerStartParams) - Required - The parameters for starting the plugin manager.

### Returns
Promise<void>
```

--------------------------------

### Range Example with Line Ending

Source: https://eclipse-theia.github.io/theia/docs/next/interfaces/_theia_editor.browser_editor.Range.html

Shows how to define a range that includes a line including its line ending character(s) by using an end position at the start of the next line. The example uses zero-based line and character indices.

```typescript
{
    start: { line: 5, character: 23 }
    end : { line 6, character : 0 }
}
```

--------------------------------

### initialize

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.plugin_webviews.WebviewsExtImpl.html

Initializes the webview extension. This method is called to set up the webview extension.

```APIDOC
## initialize

### Description
Initializes the webview extension.

### Method
initialize

### Parameters
None

### Returns
void
```

--------------------------------

### Example of process.getegid()

Source: https://eclipse-theia.github.io/theia/docs/next/interfaces/_theia_core.electron-main_electron-main-application.ElectronMainProcessArgv.ElectronMainProcess.html

Shows how to use process.getegid() to get the numerical effective group identity. This method is only available on POSIX platforms (not Windows or Android).

```javascript
import process from 'node:process';

if (process.getegid) {
  console.log(`Current gid: ${process.getegid()}`);
}
```

--------------------------------

### Configure Llamafiles in preferences

Source: https://eclipse-theia.github.io/theia/docs/next/modules/_theia_ai-llamafile.html

Example configuration for the 'ai-features.llamafile.llamafiles' setting. It is an array of objects, each defining a llamafile with a user-friendly name, the file URI, and the port to start the server on.

```json
{
    "ai-features.llamafile.llamafiles": [
        {
            "name": "MyLlamaFile",
            "uri": "file:///path/to/my.llamafile",
            "port": 30000
        }
    ]
}
```

--------------------------------

### startServer

Source: https://eclipse-theia.github.io/theia/docs/next/interfaces/_theia_ai-mcp.common_mcp-server-manager.MCPServerManager.html

Starts an MCP server.

```APIDOC
## startServer

### Description
Starts an MCP server.

### Method
startServer

### Parameters
- **serverName** (string) - Required - The name of the server.
- **options** (object) - Optional - Options for starting the server.
  - **interactive** (boolean) - Optional - Whether the server should be started interactively.

### Returns
Promise<void>
```

--------------------------------

### doInstall(options?)

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_vsx-registry.browser_vsx-extension.VSXExtension.html

Protected method to install the extension with optional deployment options. Returns a promise that resolves when the installation is complete.

```APIDOC
## doInstall(options?)

### Description
Protected method to install the extension with optional deployment options.

### Method
- doInstall(options?: PluginDeployOptions): Promise<void>

### Parameters
- `Optional` options: PluginDeployOptions - Deployment options for the plugin.

### Returns
Promise<void>
```

--------------------------------

### parent (get/set)

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_core.browser.AccordionLayout.html

Get or set the parent widget of the layout. The parent widget is set automatically when installing the layout on the parent widget and should not be set directly by user code.

```APIDOC
## Accessor: parent

### get parent(): null | Widget

Get the parent widget of the layout.

#### Returns
- null | Widget

### set parent(value: null | Widget): void

Set the parent widget of the layout.

#### Notes
- This is set automatically when installing the layout on the parent widget.
- The parent widget should not be set directly by user code.

#### Parameters
- **value** (null | Widget) - Required - The parent widget value.

#### Returns
- void
```

--------------------------------

### cpuUsage example: measure CPU time

Source: https://eclipse-theia.github.io/theia/docs/next/interfaces/_theia_core.electron-main_electron-main-application.ElectronMainProcessArgv.ElectronMainProcess.html

Shows how to use process.cpuUsage() to get user and system CPU time. Passing a previous result returns a diff reading.

```javascript
import { cpuUsage } from 'node:process';

const startUsage = cpuUsage();
// { user: 38579, system: 6986 }

// spin the CPU for 500 milliseconds
const now = Date.now();
while (Date.now() - now < 500);

console.log(cpuUsage(startUsage));
// { user: 514883, system: 11226 }
```

--------------------------------

### initialize(): void

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.plugin_env.EnvExtImpl.html

Method that initializes the environment extension.

```APIDOC
## initialize

### Description
Initializes the environment extension.

### Method
`initialize(): void`

### Returns
- **void** - No return value.
```

--------------------------------

### get ready(): Promise<void>

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_core.common_preferences_preference-service.PreferenceServiceImpl.html

Promise indicating whether the service successfully initialized.

```APIDOC
## get ready(): Promise<void>

### Description
Promise indicating whether the service successfully initialized.

### Returns
- **Promise<void>** - A promise that resolves when the service is ready.

```

--------------------------------

### Build Everything with npm run all

Source: https://eclipse-theia.github.io/theia/docs/next/documents/Developing.html

Installs dependencies, links and builds TypeScript packages, lints, and builds the example applications. This is the main build command for the entire monorepo.

```bash
npm run all
```

--------------------------------

### Clone, build, and run Theia on Windows

Source: https://eclipse-theia.github.io/theia/docs/next/documents/Developing.html

Clones the Theia repository, installs dependencies, builds the browser bundle, and starts the application. Run in Git Bash as administrator on Windows.

```bash
git clone https://github.com/eclipse-theia/theia.git \
    && cd theia \
    && npm install \
    && npm run build:browser \
    && npm run start:browser
```

--------------------------------

### doInit()

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_toolbar.browser_application-shell-with-toolbar-override.ApplicationShellWithToolbarOverride.html

Initializes the application shell. This is a protected method.

```APIDOC
## doInit()

### Description
Initializes the application shell.

### Returns
Promise<void>
```

--------------------------------

### Rebuild Browser Native Packages with npm run rebuild:browser

Source: https://eclipse-theia.github.io/theia/docs/next/documents/Developing.html

Rolls back native Node.js package changes for Electron before starting the browser example. Run from the root directory.

```bash
npm run rebuild:browser
```

--------------------------------

### constructor

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_core.electron-browser_window_electron-window-launch-args.ElectronWindowLaunchArgs.html

Creates a new instance of ElectronWindowLaunchArgs. This is an experimental API.

```APIDOC
## constructor

### Description
Creates a new instance of ElectronWindowLaunchArgs. This is an experimental API.

### Method
constructor

### Signature
new ElectronWindowLaunchArgs(): ElectronWindowLaunchArgs

### Returns
ElectronWindowLaunchArgs
```

--------------------------------

### getMaxListeners example with EventEmitter and EventTarget

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_process.node_dev-null-stream.DevNullStream.html

Shows how to get and set the maximum number of listeners using getMaxListeners and setMaxListeners. For EventTarget, exceeding the max prints a warning. Available since v19.9.0.

```javascript
import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';

{
  const ee = new EventEmitter();
  console.log(getMaxListeners(ee)); // 10
  setMaxListeners(11, ee);
  console.log(getMaxListeners(ee)); // 11
}
{
  const et = new EventTarget();
  console.log(getMaxListeners(et)); // 10
  setMaxListeners(11, et);
  console.log(getMaxListeners(et)); // 11
}
```

--------------------------------

### new InstallPluginUriConfiguration()

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_ai-registry.browser_plugin_install-plugin-uri-configuration.InstallPluginUriConfiguration.html

Creates a new instance of InstallPluginUriConfiguration.

```APIDOC
## new InstallPluginUriConfiguration()

### Description
Creates a new instance of InstallPluginUriConfiguration.

### Method
constructor

### Returns
InstallPluginUriConfiguration
```

--------------------------------

### nextTick basic usage example

Source: https://eclipse-theia.github.io/theia/docs/next/interfaces/_theia_core.electron-main_electron-main-application.ElectronMainProcessArgv.ElectronMainProcess.html

Shows the order of execution when using nextTick. The callback is queued and executed after the current operation completes, before the event loop continues. Output is start, scheduled, nextTick callback.

```javascript
import { nextTick } from 'node:process';

console.log('start');
nextTick(() => {
  console.log('nextTick callback');
});
console.log('scheduled');
// Output:
// start
// scheduled
// nextTick callback
```

--------------------------------

### onStart

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_core.common_command.CommandRegistry.html

Called when the application starts.

```APIDOC
## onStart

### Description
Called when the application starts.

### Returns
- **void**

```

--------------------------------

### install

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_ai-registry.browser_mcp_mcp-install-service.MCPInstallServiceImpl.html

Installs a new MCP server entry from the registry.

```APIDOC
## install

### Description
Installs a new MCP server entry from the registry.

### Method
install

### Signature
install(entry: ResolvedRegistryEntry): Promise<void>

### Parameters
- **entry** (ResolvedRegistryEntry) - Required - The registry entry to install.

### Returns
Promise<void>
```

--------------------------------

### getEventListeners example with EventEmitter and EventTarget

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_process.node_dev-null-stream.DevNullStream.html

Shows how to use getEventListeners to retrieve listeners for an event name. For EventEmitter, it behaves like .listeners; for EventTarget, it's the only way to get listeners. Available since v15.2.0, v14.17.0.

```javascript
import { getEventListeners, EventEmitter } from 'node:events';

{
  const ee = new EventEmitter();
  const listener = () => console.log('Events are fun');
  ee.on('foo', listener);
  console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
}
{
  const et = new EventTarget();
  const listener = () => console.log('Events are fun');
  et.addEventListener('foo', listener);
  console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
}
```

--------------------------------

### start

Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_debug.node_debug-adapter-factory.LaunchBasedDebugAdapterFactory.html

Starts a debug adapter process based on the provided executable configuration and returns a DebugAdapter instance.

```APIDOC
## start

### Description
Starts a debug adapter process based on the provided executable configuration and returns a DebugAdapter instance.

### Method
start

### Signature
start(executable: DebugAdapterExecutable): DebugAdapter

### Parameters
- executable (DebugAdapterExecutable) - Required - The executable configuration for the debug adapter.

### Returns
DebugAdapter
```
Tokens:
Raw