DockerDesktopClient Navigation and Execution Methods

▸ **navigateToContainerStats**(`id`): `Promise`<`any`\> Navigate to the container stats to see the CPU, memory, disk read/write and network I/O usage. ```typescript await window.ddClient.navigateToContainerStats(id); ``` > [!WARNING] > > It will be removed in a future version. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | The full container id, e.g. `46b57e400d801762e9e115734bf902a2450d89669d85881058a46136520aca28`. You can use the `--no-trunc` flag as part of the `docker ps` command to display the full container id. | #### Returns `Promise`<`any`\> A promise that fails if the container doesn't exist. #### Inherited from DockerDesktopClientV0.navigateToContainerStats ___ ### navigateToImages ▸ **navigateToImages**(): `void` Navigate to the images window in Docker Desktop. ```typescript await window.ddClient.navigateToImages(id); ``` > [!WARNING] > > It will be removed in a future version. Use [viewImages](NavigationIntents.md#viewimages) instead. #### Returns `void` #### Inherited from DockerDesktopClientV0.navigateToImages ___ ### navigateToImage ▸ **navigateToImage**(`id`, `tag`): `Promise`<`any`\> Navigate to a specific image referenced by `id` and `tag` in Docker Desktop. In this navigation route you can find the image layers, commands, created time and size. ```typescript await window.ddClient.navigateToImage(id, tag); ``` > [!WARNING] > > It will be removed in a future version. Use [viewImage](NavigationIntents.md#viewimage) instead. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | The full image id (including sha), e.g. `sha256:34ab3ae068572f4e85c448b4035e6be5e19cc41f69606535cd4d768a63432673`. | | `tag` | `string` | The tag of the image, e.g. `latest`, `0.0.1`, etc. | #### Returns `Promise`<`any`\> A promise that fails if the container doesn't exist. #### Inherited from DockerDesktopClientV0.navigateToImage ___ ### navigateToVolumes ▸ **navigateToVolumes**(): `void` Navigate to the volumes window in Docker Desktop. ```typescript await window.ddClient.navigateToVolumes(); ``` > [!WARNING] > > It will be removed in a future version. Use [viewVolumes](NavigationIntents.md#viewvolumes) instead. #### Returns `void` #### Inherited from DockerDesktopClientV0.navigateToVolumes ___ ### navigateToVolume ▸ **navigateToVolume**(`volume`): `void` Navigate to a specific volume in Docker Desktop. ```typescript window.ddClient.navigateToVolume(volume); ``` > [!WARNING] > > It will be removed in a future version. Use [viewVolume](NavigationIntents.md#viewvolume) instead. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `volume` | `string` | The name of the volume, e.g. `my-volume`. | #### Returns `void` #### Inherited from DockerDesktopClientV0.navigateToVolume ___ ## Other Methods ### execHostCmd ▸ **execHostCmd**(`cmd`): `Promise`<[`ExecResultV0`](ExecResultV0.md)\> You can run binaries defined in the host section in the extension metadata. ```typescript window.ddClient.execHostCmd(`cliShippedOnHost xxx`).then((cmdResult: any) => { console.log(cmdResult); }); ``` > [!WARNING] > > It will be removed in a future version. Use [exec](ExtensionCli.md#exec) instead. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `cmd` | `string` | The command to be executed. | #### Returns `Promise`<[`ExecResultV0`](ExecResultV0.md)\> #### Inherited from DockerDesktopClientV0.execHostCmd ___ ### spawnHostCmd ▸ **spawnHostCmd**(`cmd`, `args`, `callback`): `void` Invoke an extension binary on your host and get the output stream. ```typescript window.ddClient.spawnHostCmd( `cliShippedOnHost`, [`arg1`, `arg2`], (data: any, err: any) => { console.log(data.stdout, data.stderr); // Once the command exits we get the status code if (data.code) { console.log(data.code); } } ); ``` > [!WARNING] > > It will be removed in a future version. Use [exec](ExtensionCli.md#exec) instead.

This section details the navigation methods for navigating to container stats, images, a specific image, volumes, and a specific volume within Docker Desktop. It also describes methods for executing commands on the host machine. Note that all of these methods are deprecated and scheduled for removal in future versions, with suggestions to use `NavigationIntents` or `ExtensionCli.exec` instead.