WildernessLabs.Meadow.CLI 2.5.2

Getting Started

To install the latest Meadow.CLI release, run the .NET tool install command to get the latest package from NuGet.

dotnet tool install WildernessLabs.Meadow.CLI --global

For the latest getting started instructions with Meadow and Meadow.CLI, check out the Meadow guides in the Wilderness Labs documentations. Additionally, there are instructions there for updating an existing Meadow.CLI install.

If you want to develop or build a Meadow.CLI directly, or install a pre-release version, follow the instructions to install a pre-release Meadow.CLI.

Once installed, run the Meadow.CLI from a command line with meadow.

Options

To see the options, run the application with the --help arg.

Useful commands

Download Meadow OS

meadow firmware download

Update the Meadow OS

**meadow firmware write**

List available Meadow devices

**meadow list ports**

You can then specify which port to use for future commands (replace {port-name} to your desired device port, such as COM3 on Windows or /dev/tty.usbmodem336F336D30361 on macOS).

meadow config route {port-name}

Listen for Meadow Console.WriteLine

After configuring a route to the desired Meadow device.

meadow listen

Uninstall the Meadow.CLI tool

To uninstall the Meadow.CLI, remove it using the .NET command-line tool:

dotnet tool uninstall WildernessLabs.Meadow.CLI --global

Install a downloaded pre-release version

To test an unpublished pre-release builds of the Meadow.CLI tool you have downloaded, you'll need to specify some extra parameters.

1. Download a pre-release version, typically from an automated build.

2. Extract the package .nupkg file from the downloaded archive.

3. Uninstall the existing tool.

   dotnet tool uninstall WildernessLabs.Meadow.CLI --global
   

4. Install the pre-release version from the download location by providing a version parameter for {pre-release-version} and source location of the .nupkg file for {path-to-folder-with-downloaded-nupkg}.

   dotnet tool install WildernessLabs.Meadow.CLI --version '{pre-release-version}' --global --add-source '{path-to-folder-with-downloaded-nupkg}'
   

5. Verify the version of your Meadow.CLI tool.

   meadow --version
   

Re-install the official release

You can return to the official Meadow.CLI release by uninstalling and reinstalling without the local overrides:

dotnet tool uninstall WildernessLabs.Meadow.CLI --global
dotnet tool install WildernessLabs.Meadow.CLI --global

Meadow.CLI download location

If you need to find or clear out any of the OS download files retrieved by Meadow.CLI, they are located in a WildernessLabs folder in the user directory.

• Windows: %LOCALAPPDATA%\WildernessLabs\Firmware
• macOS
  • .NET 8 or newer: ~/Library/Application Support/WildernessLabs/Firmware
  • .NET 7 or earlier: ~/.local/share/WildernessLabs/Firmware/

Building the CLI

To build the CLI from source, you'll need to clone the Meadow.CLI repo. You'll also need several other repos cloned at the same folder level:

• Meadow.Units
• Meadow.Contracts
• Meadow.Logging