Now shipped in Docker Desktop

Docker Extensions CLI

The Docker Extension CLI is now shipped by default with Docker Desktop version 4.10.0 and higher.
There is no other prerequisites to install in addition to Docker Desktop, in order to start install or build your own extensions

Major updates

• docker extension CLI is now part of Docker Desktop, no separate install
• Documentation content has been moved to https://github.com/docker/docker.github.io.
• docker extension init now generates Typescript code (instead of JavaScript)
• docker extension init go build has been containerized. Having Go installed is not required anymore.

Bug Fixes

• The init template comes with a go.mod file in the vm directory. Fixes #178
• The init template comes with a global .gitignore file. Fixes #169

v0.2.4

Docker Desktop and Docker extension CLI

Docker Desktop version 4.8.0 enables the beta version of Docker Extensions for all Mac, Windows and Linux users.

• Windows
• Mac
• Linux

In order to develop your own extensions, you will need the Docker Extensions CLI.
Please find platform-specific CLI release assets attached below.

Major updates

• New Image label which allows providing a changelog for each extension version
• CLI Warning on docker extension install and docker extension update

More details

Bug Fixes

• Fix links in extension description image label or changelog image label, now opening in an external browser
• Fix socket path depending on username on mac, that sometimes lead to socket path being too long

What's Changed

• Add doc for the changelog label by @benja-M-1 in #140
• align the docs with Docker's style guide and other documentation by @aevesdocker in #141
• Warn users about installing extensions with the CLI by @gtardif in #142
• preparing docs for inclusion in docs.docker.com by @gtardif in #143

New Contributors

• @aevesdocker made their first contribution in #141

Full Changelog: v0.2.3...v0.2.4

v0.2.3

Docker Desktop with Extensions capabilities

• mac (intel): https://desktop-stage.docker.com/mac/main/amd64/77651/Docker.dmg
• mac (arm): https://desktop-stage.docker.com/mac/main/arm64/77651/Docker.dmg
• win: https://desktop-stage.docker.com/win/main/amd64/77651/Docker%20Desktop%20Installer.exe
• linux: https://desktop-stage.docker.com/linux/main/amd64/77651/docker-desktop.deb

Docker Extensions CLI: please find platform-specific release assets attached below.

Major updates

• New API to open a file selector dialog
• New API to close spawn processes
• Long lived processes started with JS API `exec(streamingOptions) are closed automatically (SIGTERM) when leaving the extension tab.
• Ability to preview how your extension will render in the Marketplace
• Additional extension image labels to provide a detailed description, screenshots and additional links that will appear in extension details page in the Marketplace
• docker extension validate now detect obsolete fields name and provider in metadata.json and reports they should be removed.

More details

Bug Fixes

• Fix updating extension that was deleting volumes mentioned in the extension compose files. Updating does now keep volumes and extensions using backend services can store application state in volumes.

What's Changed

• Remove docs site password by @felipecruz91 in #127
• Add details labels to the docs by @felipecruz91 in #125
• Api changes 0.2.3 by @gtardif in #128
• Add docs about previewing image labels rendering by @gtardif in #133
• Fix label doc for screenshots by @benja-M-1 in #135
• Fix typos by @benja-M-1 in #132
• Change link to VM UI extension in doc by @benja-M-1 in #136
• Fix broken link by @gtardif in #137

Full Changelog: v0.2.2...v0.2.3

v0.2.2

Docker Desktop with Extensions capabilities

• mac (intel): https://desktop-stage.docker.com/mac/main/amd64/77074/Docker.dmg
• mac (arm): https://desktop-stage.docker.com/mac/main/arm64/77074/Docker.dmg
• win: https://desktop-stage.docker.com/win/main/amd64/77074/Docker%20Desktop%20Installer.exe
• linux: https://desktop-stage.docker.com/linux/main/amd64/77074/docker-desktop.deb

Docker Extensions CLI: please find platform-specific release assets attached below.

Major updates

• js API library available to use in your extension code, with Typescript support. Allows auto-complete of extension API invocation in your IDE
• New APIs to get host platform, arch and hostname
• New API to split output by lines when streaming CLI output (useful to read logs, docker events output, ...)
• Users will be notified when a new version of an extension is published and will be able to update it
• docker extension validate validate more extension information required to get extensions working and ready to be included in the Marketplace

More details

More changes

• docker extension init generates a sample extension using the Docker Extension API library by default
• Various improvements in the Marketplace (including and extension details popup) and the extension sidebar menus
• Added new extensions in the Marketplace

Bug Fixes

• Fixed path paramaters being updated when invoking extension host CLI commands
• Fixed a quick white flash displayed when opening an extension in Dark mode
• Fixed cropped icons in the Marketplace

What's Changed

• Front end tutorial fixes. by @Shy in #105
• Add new docs by @felipecruz91 in #106
• Fix old img label for extension icon, minor other fixes by @gtardif in #107
• Update samples by @benja-M-1 in #108
• Doc about importing/using api-client library by @gtardif in #110
• Document building multi-arch extensions by @felipecruz91 in #111
• [Docs] Addition of a hyperlink for convenient reference to labels by @leecalcote in #115
• Specify linux/amd64 and linux/arm64 archs in the docs by @felipecruz91 in #114
• Update tutorials to use API client libs, and update them to base them on a React frontend by @gtardif in #113
• Add Apache 2.0 license by @gtardif in #118
• Remove obsolete fields from metadata.json by @gtardif in #116
• Update docs generated from API by @gtardif in #120

New Contributors

• @Shy made their first contribution in #105
• @benja-M-1 made their first contribution in #108
• @leecalcote made their first contribution in #115

Full Changelog: v0.2.1...v0.2.2

v0.2.1

Docker Desktop with Extensions capabilities

• mac (intel): https://desktop-stage.docker.com/mac/main/amd64/75296/Docker.dmg
• mac (arm): https://desktop-stage.docker.com/mac/main/arm64/75296/Docker.dmg
• win: https://desktop-stage.docker.com/win/main/amd64/75296/Docker%20Desktop%20Installer.exe
• linux: https://desktop-stage.docker.com/linux/main/amd64/75296/docker-desktop.deb

Docker Extensions CLI: please find platform-specific release assets attached below.

Bug Fixes

• Fix extensions not working on Docker Desktop for Linux! 🐧

Known issues

• Some extensions do not fully work on Linux. The "Log in with browser" button won't work on Tailscale but you can log in with the QR code. In the Snyk and Tailscale extensions, external links will not open in the browser. This will hopefully be fixed quickly in upcoming versions of these extensions.

More details

What's Changed

• Update docs to include info about shipping linux binaries by @felipecruz91 in #101
• Update prerequisites by @felipecruz91 in #102
• Minor backend section changes by @gtardif in #103

Full Changelog: v0.2.0...v0.2.1

v0.2.0

Docker Desktop with Extensions capabilities

• mac (intel): https://desktop-stage.docker.com/mac/main/amd64/75184/Docker.dmg
• mac (arm): https://desktop-stage.docker.com/mac/main/arm64/75184/Docker.dmg
• win: https://desktop-stage.docker.com/win/main/amd64/75184/Docker%20Desktop%20Installer.exe
• linux: https://desktop-stage.docker.com/linux/main/amd64/75184/docker-desktop.deb

Docker Extensions CLI: please find platform-specific release assets attached below.

Major updates

• Support for Desktop Linux! 🐧 (see Docker Desktop for Linux - Tech Preview)
• New set of APIs, old APIs are still supported for backward compatibility and marked deprecated, but will be removed in a next release
• Support for host bind mounts in extension VM services

More details

More changes

• docker extension init generates a sample extension using the Docker MUI Theme by default
• Display an error message when an extension is either not compatible with the current API version of the extension SDK or is not built for the target platform and architecture.
• Extensions CLI is now signed and notarized.

Bug Fixes

• Extensions are deleted when uninstalling Docker Desktop
• Focusing back to Docker Desktop after extension login process fixed on windows
• Refresh the extensions on the left menu automatically when an extension is installed or uninstalled
• Fix issues with extension socket names sometimes being too long.

What's Changed

• Reordering of APIs by categories, minor updates by @gtardif in #82
• Remove tailscale sample, totally out of date with real taislcale extension by @gtardif in #83
• Fix main docs title + minor overview update by @gtardif in #84
• Add documentation about different backend requests authors can make by @rumpl in #86
• Move the documentation a bit by @rumpl in #90
• Deploy docs with GHA by @felipecruz91 in #85
• Fix Netlify GHA by @felipecruz91 in #93
• Fix links in the UI API overview page by @rumpl in #92
• Update docs with new versioning info by @felipecruz91 in #72
• Document API changes (manual approach) by @felipecruz91 in #95
• Move samples into samples folder by @gtardif in #97
• Add sample about docker theme, move up design docs by @gtardif in #96
• Update sample code to use new APIs by @gtardif in #98
• Add docs for linux CLI install by @gtardif in #99

Full Changelog: v0.0.1-alpha-6...v0.2.0

v0.0.1-alpha-6

Docker Desktop with Extensions capabilities

• mac (intel): https://desktop-stage.docker.com/mac/main/amd64/74289/Docker.dmg
• mac (arm): https://desktop-stage.docker.com/mac/main/arm64/74289/Docker.dmg
• win: https://desktop-stage.docker.com/win/main/amd64/74289/Docker%20Desktop%20Installer.exe

Docker Extensions CLI: please find platform-specific release assets attached below.

Major updates

• Updated docs with UI Guidelines and the Material UI package to replicate Docker Desktop's look & feel.
• New API method window.ddClient.openExternal(url) to open external links.

More details

Bug Fixes

• Display a default icon when the extension icon cannot be loaded (e.g. 404 from an external URL).
• Clean up the leftover container after a failed extension install, e.g. when installing non-multi-arch extensions.
• Fix docker extension validate command on Windows.

What's Changed

• update wrong image label for icon by @gtardif in #75
• Design guidelines by @mel-manohar in #71
• Remove obsolete desktop-plugin-version from all metadata samples & docs by @gtardif in #76
• Update references to desktop-extension-samples by @gtardif in #78
• Add documentation for the openExternal function by @rumpl in #77
• MUI Theme by @mel-manohar in #79
• Nicer confirmation that everything is setup properly at the end of prerequisites by @gtardif in #80
• Update Tailscale sample with openExternal API method by @felipecruz91 in #81

New Contributors

• @mel-manohar made their first contribution in #71

Full Changelog: v0.0.1-alpha-5...v0.0.1-alpha-6

v0.0.1-alpha-5

Docker Desktop build with Extensions capabilities

• mac (intel): https://desktop-stage.docker.com/mac/main/amd64/74216/Docker.dmg
• mac (arm): https://desktop-stage.docker.com/mac/main/arm64/74216/Docker.dmg
• win: https://desktop-stage.docker.com/win/main/amd64/74216/Docker%20Desktop%20Installer.exe

Docker Extensions CLI

Please find platform-specific release assets attached below.

Major updates

• WSL2 support : the docker extension CLI (docker extension xxx) can be used fro WSL2 in order to develop extensions form a WSL2 terminal
• Added the ability to execute commands and get live output updates. This also resolves issues with commands returning large output.

Bug Fixes

• Navigation APIs to a specific container of image return a promise, and might return an error if the UI can't navigate to this container or image
• Allow to debug/hot reload code from extensions with an org in the image name
• Exit chrome dev tools (if opened) when navigating away from an extension tab. This voids some crashes of Docker Desktop

What's Changed

• Fix ref in docs by @felipecruz91 in #70
• Add documentation for the spawn* functions by @rumpl in #73
• Add WSL2 instructions for CLI install by @felipecruz91 in #74

Full Changelog: v0.0.1-alpha-4...v0.0.1-alpha-5

v0.0.1-alpha-4

Docker Desktop build with Extensions capabilities

• mac (intel): https://desktop-stage.docker.com/mac/main/amd64/73745/Docker.dmg
• mac (arm): https://desktop-stage.docker.com/mac/main/arm64/73745/Docker.dmg
• win: https://desktop-stage.docker.com/win/main/amd64/73745/Docker%20Desktop%20Installer.exe

Docker Extensions CLI

Please find platform-specific release assets attached below.

Bug Fixes

• When executing commands with ddClient.execDockerCmd(...), ddClient.execHostCmd(...) or ddClient.backend. execInVMExtension(...) , if the command exits with an error code, the js invocation can try/catch and read the error, that has the same fields and convenience methods as the cmd result.

What's Changed

• Add dashboard navigation docs by @felipecruz91 in #59
• Add doc for systematically opening chrome dev tools while developing a specific extension by @gtardif in #69
• Add docker commands tutorial to TOC by @gtardif in #62
• Fix typo by @mat007 in #63
• Explicitly enable the extension feature by @rumpl in #64
• Fix small typo in tutorial by @silvin-lubecki in #65
• Tailscale browser login (rebase) by @felipecruz91 in #51
• Fix error in API docs by @gtardif in #66
• Update the Konami code by @rumpl in #67

New Contributors

• @mat007 made their first contribution in #63
• @silvin-lubecki made their first contribution in #65

Full Changelog: v0.0.1-alpha3...v0.0.1-alpha-4

v0.0.1-alpha3

⚠️ If you have already installed extensions, for this specific release you need to remove installed extensions before upgrading to this release, and reinstall them afterwards.
If you have upgraded before installing the new release, you can remove old extension folders from ~/Library/Containers/com.docker.docker/Data/plugins (mac) and ~\AppData\Roaming\Docker\Desktop\plugins (win)

No specific change is required in the extension code

Docker Desktop build with Extensions capabilities

• mac (intel): https://desktop-stage.docker.com/mac/main/amd64/72788/Docker.dmg
• mac (arm): https://desktop-stage.docker.com/mac/main/arm64/72788/Docker.dmg
• win: https://desktop-stage.docker.com/win/main/amd64/72788/Docker%20Desktop%20Installer.exe

Docker Extensions CLI

Please find platform-specific release assets attached below.

Bug Fixes

• Fix hot reload bug in docker extension dev ui-source myextension http://localhost:3000, the extension ui should now hot-reload properly.

What's Changed

• New API to run docker commands from the Extension UI + tutorial by @gtardif in #60
• New docker extension init command by @rumpl in #61
• Generate docs with MkDocs by @felipecruz91 in #53
• Adding link to figma design guidelines by @gtardif in #58
• Extension screen is now showing progress and install/uninstall log details are accessible

Full Changelog: v0.0.1-alpha.2...v0.0.1-alpha3