Method list_instances

unity_cli/client.py:451–478

List all connected Unity instances. Returns: List of instance info dictionaries with keys: - instance_id: Project path - project_name: Project name - unity_version: Unity version - status: Connection status - is_default

(self)

            sock.close()

    def list_instances(self) -> list[dict[str, Any]]:
        """List all connected Unity instances.

        Returns:
            List of instance info dictionaries with keys:
            - instance_id: Project path
            - project_name: Project name
            - unity_version: Unity version
            - status: Connection status
            - is_default: Whether this is the default instance
        """
        message = {
            "type": "LIST_INSTANCES",
            "id": _generate_request_id(self._client_id),
            "ts": int(time.time() * 1000),
        }

        response = self._send_admin_message(message)

        if response.get("type") == "INSTANCES":
            data: dict[str, Any] = response.get("data", {})
            instances: list[dict[str, Any]] = data.get("instances", [])
            return instances

        raise ProtocolError(
            f"Unexpected response type: {response.get('type')}",
            "PROTOCOL_ERROR",
        )

    def set_default_instance(self, instance_id: str) -> bool:
        """Set the default Unity instance.