diff --git a/INSTALL.md b/INSTALL.md index d0f5cc00..02c36933 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -191,6 +191,11 @@ regular (non-root) user account, especially if using a user-managed node install Search for the installation command for your distribution. E.g. for Ubuntu: `sudo apt-get install avahi-daemon` * macOS comes with [Bonjour](https://en.wikipedia.org/wiki/Bonjour_(software)) built-in. + +* The `balena os configure` command is currently not supported on Windows natively. Windows users are advised + to install the [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/about) (WSL) + with Ubuntu, and use the Linux release of the balena CLI. + ## Configuring SSH keys diff --git a/doc/cli.markdown b/doc/cli.markdown index 68f1a9e0..1196c9b1 100644 --- a/doc/cli.markdown +++ b/doc/cli.markdown @@ -1567,6 +1567,11 @@ https://developer.gnome.org/NetworkManager/stable/nm-settings.html The --device-api-key option is deprecated and will be removed in a future release. A suitable key is automatically generated or fetched if this option is omitted. +Note: This command is currently not supported on Windows natively. Windows users +are advised to install the Windows Subsystem for Linux (WSL) with Ubuntu, and use +the Linux release of the balena CLI: +https://docs.microsoft.com/en-us/windows/wsl/about + Examples: $ balena os configure ../path/rpi3.img --device 7cf02a6 diff --git a/lib/actions-oclif/os/configure.ts b/lib/actions-oclif/os/configure.ts index e51482a8..8acd9c76 100644 --- a/lib/actions-oclif/os/configure.ts +++ b/lib/actions-oclif/os/configure.ts @@ -94,6 +94,11 @@ export default class OsConfigureCmd extends Command { https://developer.gnome.org/NetworkManager/stable/nm-settings.html ${deviceApiKeyDeprecationMsg.split('\n').join('\n\t\t')} + + Note: This command is currently not supported on Windows natively. Windows users + are advised to install the Windows Subsystem for Linux (WSL) with Ubuntu, and use + the Linux release of the balena CLI: + https://docs.microsoft.com/en-us/windows/wsl/about `; public static examples = [ '$ balena os configure ../path/rpi3.img --device 7cf02a6',