Theia API Documentation v1.76.0
    Preparing search index...

    Frontend contribution that provides additional CLI arguments to pass to a remote backend started for the current window (e.g. when attaching to a dev container).

    This lets per-window CLI options (such as --session-preference) that were forwarded to a window be re-applied on the remote backend. Unlike the node-side RemoteCliContribution#enhanceArgs, which reads process-global state on the shared backend, this contribution runs in the renderer and therefore has access to the current window's context.

    interface RemoteCliArgsContribution {
        getRemoteCliArgs(): MaybePromise<string[]>;
    }

    Implemented by

    Index

    Methods

    • Experimental

      Returns the extra CLI arguments to append when starting a remote backend for the current window. Implementations should return an empty array when they have nothing to contribute (e.g. for a regular cold-start window whose args are already applied by the shared backend).

      Returns MaybePromise<string[]>