Skip to content

Mac OS X brew download/install instructions #2597

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 30, 2025
Merged

Mac OS X brew download/install instructions #2597

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
433348f
chore: Instruct Mac OS X users to use brew to install mender-artifact
vpodzime May 13, 2025
c72753c
chore: Instruct Mac OS X users to use brew to install mender-cli
vpodzime May 13, 2025
e0c87f9
chore: Point the mender-cli usage docs to downloads#mender-cli
vpodzime May 13, 2025
396b920
chore: Align heading level in Deploy an Operating System update
vpodzime May 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 3 additions & 10 deletions 01.Get-started/03.Deploy-an-operating-system-update/docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ You should:
* know the IP address of your device


### Step 1 - Download the mender-artifact utility on your workstation
## Step 1 - Download the mender-artifact utility on your workstation

!!! The simplest installation instructions for `mender-artifact` are covered below, see
!!! [Downloads](../../11.Downloads/docs.md#mender-artifact) for installation alternatives such as
Expand All @@ -38,19 +38,12 @@ wget https://downloads.mender.io/repos/debian/pool/main/m/mender-artifact/mender
sudo dpkg --install mender-artifact_4.1.0-1+$(. /etc/os-release; echo $ID)+$(. /etc/os-release; echo $VERSION_CODENAME)_amd64.deb
```

On MacOS, download the `mender-artifact` binary, give exec permissions, and add it to your path:
On MacOS, install `mender-artifact` from `brew` using:

<!--AUTOVERSION: "mender-artifact/%/"/mender-artifact -->
```bash
mkdir -p ${HOME}/bin
wget https://downloads.mender.io/mender-artifact/4.1.0/darwin/mender-artifact -O ${HOME}/bin/mender-artifact
chmod +x ${HOME}/bin/mender-artifact
export PATH="${PATH}:${HOME}/bin"
brew install mender-artifact
```

!!! Add the last line from above to `~/.bashrc` or equivalent to make it persistent across multiple
!!! terminal sessions.

## Step 2 - Setup shell variables on your workstation

Setup the `IP_ADDRESS` shell variable with correct IP address of your device:
Expand Down
7 changes: 3 additions & 4 deletions 09.Server-integration/01.Using-the-apis/docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,13 +151,12 @@ It supports use cases for cloud systems, like uploading an Artifact to the Mende

Over time the functionality of `mender-cli` will be extended to simplify the most common use cases for integrating the Mender Server into other backend and cloud systems. If you need to cover other use cases today, follow the [tutorial for cURL instead](#install-curl-and-jq-and-set-up-the-shell-variables).

First download the [prebuilt mender-cli Linux binary here][x.x.x_mender-cli].
First install the `mender-cli` tool as described in the [Downloads page][../../11.Downloads/docs.md#mender-cli].

Then open a terminal in the directory you downloaded `mender-cli` and run the following commands to log in to your Mender Server.
Then open a terminal and run the following command to log in to your Mender Server.

```bash
chmod +x mender-cli
./mender-cli login --server https://hosted.mender.io --username [email protected]
mender-cli login --server https://hosted.mender.io --username [email protected]
```

!!! Adjust the server URI and email to the correct values for the server you are using.
Expand Down
52 changes: 32 additions & 20 deletions 11.Downloads/docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,10 @@ which are files with the `.mender` suffix and contain software to be deployed.
See [Artifact creation](../07.Artifact-creation/chapter.md) for more information on how to
use this utility.

Follow the correct link according to your host platform to download
`mender-artifact` deb package or as an standalone utility:
### Debian/Ubuntu

Follow the correct link according to your host platform to download the
`mender-artifact` deb package:

<!--AUTOVERSION: "mender-artifact %][x.x.x_mender-artifact-"/mender-artifact -->
| Platform | Download link |
Expand All @@ -61,10 +63,9 @@ Follow the correct link according to your host platform to download
| Ubuntu 22.04 | [mender-artifact 4.1.0][x.x.x_mender-artifact-ubuntu2204] |
| Debian 12 | [mender-artifact 4.1.0][x.x.x_mender-artifact-debian12] |
| Debian 11 | [mender-artifact 4.1.0][x.x.x_mender-artifact-debian11] |
| Mac OS X (x86-64) | [mender-artifact 4.1.0][x.x.x_mender-artifact-darwin] |

!!! * For Debian and Ubuntu, you can also install `mender-artifact` through the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we remove the above table to packages, and change this package repo way to be the only way to install mender-artifact.

!!! [Mender APT repositories](#install-using-the-apt-repository).
You can also install `mender-artifact` through the [Mender APT
repositories](#install-using-the-apt-repository).

<!--AUTOVERSION: "mender-artifact_%-1"/mender-artifact -->
[x.x.x_mender-artifact-ubuntu2404]: https://downloads.mender.io/repos/debian/pool/main/m/mender-artifact/mender-artifact_4.1.0-1%2Bubuntu%2Bnoble_amd64.deb
Expand All @@ -74,14 +75,20 @@ Follow the correct link according to your host platform to download
[x.x.x_mender-artifact-debian12]: https://downloads.mender.io/repos/debian/pool/main/m/mender-artifact/mender-artifact_4.1.0-1%2Bdebian%2Bbookworm_amd64.deb
<!--AUTOVERSION: "mender-artifact_%-1"/mender-artifact -->
[x.x.x_mender-artifact-debian11]: https://downloads.mender.io/repos/debian/pool/main/m/mender-artifact/mender-artifact_4.1.0-1%2Bdebian%2Bbullseye_amd64.deb
<!--AUTOVERSION: "mender-artifact/%/"/mender-artifact -->
[x.x.x_mender-artifact-darwin]: https://downloads.mender.io/mender-artifact/4.1.0/darwin/mender-artifact

! If you are using Mac OS X, note that using `mender-artifact` with
! disk image files (e.g.: `*.sdimg`, `*.img`, or others holding the storage
! partitions) has limited functionality. Commands like
! `mender-artifact cat` or `mender-artifact cp` will not work due to lack
! of support for certain utilities on the Mac platform.
### Mac OS X

Use `brew` to install `mender-artifact` from [the Homebrew repository](https://brew.sh/):

```bash
brew install mender-artifact
```

! Note that using `mender-artifact` on MacOS with disk image files (e.g.: `*.sdimg`,
! `*.img`, or others holding the storage partitions) has limited functionality. Commands
! like `mender-artifact cat` or `mender-artifact cp` will not work due to lack of support
! for certain utilities on the Mac platform.


!!! `mender-artifact` binary is shipped also in [mender-ci-tools Docker image](https://hub.docker.com/r/mendersoftware/mender-ci-tools). More information [here](../07.Artifact-creation/10.CI-CD/docs.md#mender-ci-workflows-docker-image).

Expand Down Expand Up @@ -436,16 +443,14 @@ of the Mender Server API, such as uploading a Mender Artifact, from
the command line. See [Server integration](../09.Server-integration/chapter.md) for
more information.

Follow the correct link according to your host platform to download `mender-cli`:
### GNU/Linux

<!--AUTOVERSION: "keeps \"%\" version"/ignore-->
<!-- The second column points to pre-release software and keeps "master" version in the name and link -->
<!--AUTOVERSION: "mender-cli %][x.x.x_mender-cli-"/mender-cli "mender-cli %][%_mender-cli-"/ignore-->
| Platform | Download link | |
|----------|----------------------------------------------|-------------------------------------------------------------|
| Linux | [mender-cli 1.12.0][x.x.x_mender-cli-linux] | [mender-cli master][master_mender-cli-linux] (Pre-release) |
| Mac OS X | [mender-cli 1.12.0][x.x.x_mender-cli-darwin] | [mender-cli master][master_mender-cli-darwin] (Pre-release) |

| Latest release | Pre-release |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unsure about the naming of columns, someone should verify that -- I have no idea.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch: as we move away from binaries to packages, we won't offer here anymore a "pre-release" version (iow master) for the tool.

We can remove now or remove after having the mender-cli Linux (Debian/Ubuntu) packages in place.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove after having the mender-cli Linux (Debian/Ubuntu) packages in place

I'd leave it to that batch of changes.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking we remove all such download tables now that we're using the repos.

|----------------------------------------------|-------------------------------------------------------------|
| [mender-cli 1.12.0][x.x.x_mender-cli-linux] | [mender-cli master][master_mender-cli-linux] |

Remember to add execute permission and ensure that the mender-cli utility is in a directory that is specified in your [PATH environment variable](https://en.wikipedia.org/wiki/PATH_(variable)?target=_blank). Most systems automatically have `/usr/local/bin` in your PATH so the following should allow proper execution and location of this binary.

Expand All @@ -459,10 +464,17 @@ Please refer to your host Operating System documentation for more details.

<!--AUTOVERSION: "mender-cli/%/"/mender-cli -->
[x.x.x_mender-cli-linux]: https://downloads.mender.io/mender-cli/1.12.0/linux/mender-cli
[x.x.x_mender-cli-darwin]: https://downloads.mender.io/mender-cli/1.12.0/darwin/mender-cli
<!--AUTOVERSION: "[%_mender-cli-"/ignore "mender-cli/%/"/ignore -->
[master_mender-cli-linux]: https://downloads.mender.io/mender-cli/master/linux/mender-cli
[master_mender-cli-darwin]: https://downloads.mender.io/mender-cli/master/darwin/mender-cli

### Mac OS X

Use `brew` to install `mender-cli` from [the Homebrew repository](https://brew.sh/):

```bash
brew install mender-cli
```


!!! `mender-cli` binary is shipped also in [Docker image](https://hub.docker.com/r/mendersoftware/mender-ci-tools). More information [here](../07.Artifact-creation/10.CI-CD/docs.md#mender-ci-workflows-docker-image).

Expand Down