Skip to content

Commit 97993ef

Browse files
CryptoTotalWartegefaulkes
authored andcommitted
docs(macOS): clarify download and rename steps for Polykey installation
1 parent 3995e4e commit 97993ef

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

docs/tutorials/polykey-cli/installation.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -103,18 +103,25 @@ We will be working on other distribution methods.
103103

104104
:::info
105105

106-
ARM-64 builds don't work on MacOS as of **20-12-23.**
107-
However, building polykey yourself on MacOS resolves in a working binary.
106+
ARM-64 builds are not currently supported on MacOS as of **26-03-24.**
107+
However, building Polykey yourself on MacOS resolves in a working binary. Follow this guide below to manually build and install Polykey on macOS.
108108

109109
:::
110110

111-
Builds for MacOS are released on GitHub: https://github.com/MatrixAI/Polykey-CLI/releases.
111+
### Manually
112+
113+
1. Download the Polykey CLI for macOS from the [GitHub releases page](https://github.com/MatrixAI/Polykey-CLI/releases). Look for the file named `polykey-cli-V.V.V-darwin-universal`, where `V.V.V` is the version number. For Mac, you want to download the file with the `darwin-universal` file extension.
114+
115+
2. Rename the downloaded file to `polykey` for easier access. In your terminal, make sure to navigate to the directory where the file is located (usually the Downloads directory) and run the following command:
112116

113-
Download the executable named `...-polykey-cli-V.V.V-darwin-universal`, and rename it to `polykey`.
117+
```sh
118+
mv polykey-cli-V.V.V-darwin-universal polykey
119+
```
114120

115121
:::tip
116122

117-
Make sure to cd into the directory where your Polykey CLI executable is located first. Typically this would be your Downloads directory.
123+
- Replace `V.V.V.` with the actual version number of the file you downloaded.
124+
- Navigate into the directory where the file is saved to execute commands.
118125

119126
:::
120127

@@ -123,7 +130,7 @@ Make the Executable Runnable:
123130
Before you can run the Polykey CLI, you need to make it executable. Use the chmod command to add executable permissions to the file. Replace polykey-cli-0.2.6-darwin-universal with the actual name of the file if it's different:
124131

125132
```sh
126-
chmod +x polykey-cli-V.V.V-darwin-universal
133+
chmod +x polykey
127134
```
128135

129136
MacOS requires additional steps for the binary to be allowed to execute,

0 commit comments

Comments
 (0)