Installation

Installing the CLI can be done in different ways depending on your operating environment.

info

Polykey-CLI has only been tested on Linux and macOS. We are working on supporting other platforms. There's minor teething problems when it comes supporting other platforms. Help us by reporting any issues with the CLI tool in our Github Repo here or by dropping a message to the developers in our discord server here.

Linux

Linux

Polykey-CLI code is compiled, bundled and wrapped into a single file executable. You just have to download the executable, give it executable permissions and run it. The executable is not statically linked. It requires a subset of the system libraries that Node.js requires.

• libdl.so.2
• libstdc++.so.6
• libm.so.6
• libgcc_s.so.1
• libpthread.so.0
• libc.so.6

Manually

Builds for Linux is released on GitHub: https://github.com/MatrixAI/Polykey-CLI/releases.

Download the executable named ...-polykey-cli-V.V.V-linux-x64, and rename it to polykey.

Make it executable:

$ chmod u+x ./polykey

Add it to your $PATH.

For ZSH:

1. cd into directory where polykey exec is stored.
2. Edit the zsh config to add polykey to your path. To streamline the process, run the following command, making sure to change the path to polykey if the polykey executable is not in the downloads folder.
3. For most users, this would be ~/Downloads

warning

Make sure your path to the polykey executable is correct.

$ echo 'export PATH=~/Downloads/polykey:$PATH' >> ~/.zshrc && source ~/.zshrc

You only need to run this command once. After running this command, you can now invoke polykey by typing polykey into the terminal.

---

For Bash:

1. cd into directory where polykey exec is stored.
2. Edit the zsh config to add polykey to your path. To streamline the process, run the following command, making sure to change the path to polykey if the polykey executable is not in the downloads folder.
3. For most users, this would be ~/Downloads

warning

Make sure your path to the polykey executable is correct.

$ echo 'export PATH=~/Downloads/polykey:$PATH' >> ~/.bashrc && source ~/.bashrc

You only need to run this command once. After running this command, you can now invoke polykey by typing polykey into the terminal.

---

NixOS

We have not yet published a Nix package for Polykey. When we do, you will be able to just install polykey-cli from Nixpkgs.

However, it is easy enough to install it from source.

Clone the repository:

$ git clone https://github.com/MatrixAI/Polykey-CLI.git

Enter the nix-shell:

$ nix-shell

Build the application and install it into the user profile:

$ nix-env -f ./release.nix --install --attr application --argstr npmDepsHash "$(prefetch-npm-deps ./package-lock.json)"

Other

We will be working on other distribution methods.

MacOs

MacOS

info

ARM-64 builds are not currently supported on MacOS as of 26-03-24. However, building Polykey yourself on MacOS resolves in a working binary. Follow this guide below to manually build and install Polykey on macOS.

Manually

1. Download the Polykey CLI for macOS from the GitHub releases page. 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.

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:

 mv polykey-cli-V.V.V-darwin-universal polykey

tip

• Navigate into the directory where the file is saved to execute commands.
• Replace V.V.V. with the actual version number of the file you downloaded.

3. Make the Executable Runnable: Before you can run the Polykey CLI, you need to make it executable. Use the chmod +x command to add executable permissions to the file. Replace polykey with the actual name of your file if it's different:

chmod +x polykey

---

MacOS Security Bypass

MacOS requires additional steps for the binary to be allowed to execute, this is due to the fact that as of 20-12-23, the binaries we release are unsigned, and MacOS permits running of unsigned binaries, however, to progress past this, there are a couple options:

Method #1 - Admin CLI

Method #1 - quickest method

The xattr command will remove the quarantine attribute from the Polykey executable, allowing you to run it without triggering macOS security warnings. Remember to ensure that the file path matches the location of your polykey file.

sudo xattr -r -d com.apple.quarantine ~/Downloads/polykey

If you have completed this sucesfully, you may ignore Method #2 and move to the next section on how to add polykey to your $PATH.

---

Method #2 - Apple Setting GUI

Method #2 - Using the Apple Systems Settings GUI

First type the following command to try running the Polykey CLI but will instead trigger a pop-up.

./polykey --version

1. MacOS will then prompt you with the following:

important

Do not close this prompt. If you do, the 'Allow Anyway' option will not appear in the next step.

2. While keeping the prompt open, head over to Settings -> Privacy & Security and scroll down till you see '"polykey" was blocked from use because it is not from an identified developer.'

3. Click on Allow Anyway and authenticate.

4. Try opening polykey with

sudo ./polykey

tip

When prompted in the terminal, type your administrator password and hit enter.

5. Following this, you will get another similar prompt

Click on Open and now Polykey-CLI should be running in your terminal window.

tip

You can also verify the version of polykey that was installed with:

./polykey --version

---

Add Polykey to your $PATH.

To enable running the Polykey CLI from any directory in the terminal on macOS, you'll need to update your shell configuration file.

ZSH (default shell on recent macOS versions)

For ZSH (default shell on recent macOS versions):

1. Navigate (cd) into the directory where the "polykey" executable is stored.

2. Edit the Zsh configuration file to add "polykey" to your $PATH. Use the following command, ensuring to replace ~/Downloads with the correct path to the "polykey" executable if it's not in the downloads folder. For most users, this path would be ~/Downloads on Debian-based systems.

tip

Make sure your path to the "polykey" executable is correct.

echo 'export PATH=~/Downloads:$PATH' >> ~/.zshrc && source ~/.zshrc

Bash

For Bash:

1. cd into the directory where the "polykey" executable is stored.
2. Edit the Bash config to add "polykey" to your path. To streamline the process, run the following command, making sure to change the path to "polykey" if the executable is not in the downloads folder. For most users, this would be ~/downloads on Debian-based systems.

tip

Make sure your path to the "polykey" executable is correct. Replace downloads with the path to the working directory

echo 'export PATH=~/downloads:$PATH' >> ~/.bashrc && source ~/.bashrc

tip

You can check if the PATH environment variable for Polykey has been updated correctly by running:

polykey --version

If this command returns the current version, then you have successfully added Polykey to your PATH, and you can now run polykey from anywhere in your terminal.

Windows

warning

Polykey for windows should be working but we have yet to create documentation on the installation process for this.

Docker

Docker

The Docker image can be used so that Polykey can be deployed into the cloud. It is also possible to use the CLI via the docker container, but it isn't as convenient. The intention is to run the Polykey agent in the cloud.

Docker images is released on GitHub: https://github.com/MatrixAI/Polykey-CLI/releases.

Download the image named ...-docker-image-polykey-cli-V.V.V.tar.gz and rename it to docker-image-polykey-cli.tar.gz.

Load it into Docker:

loaded="$(docker load --input "$(nix-build ./release.nix --attr docker --argstr npmDepsHash "$(prefetch-npm-deps ./package-lock.json)")")"
image="$(cut -d' ' -f3 <<< "$loaded")"
docker run -it "$image"

Docker for Mac

tip

You can install nix for MacOS and then follow the general docker instructions above. Nix for mac can be installed by running

sh <(curl -L https://nixos.org/nix/install)

1. Download the latest build of Polykey-CLI for docker from https://polykey.com/download.

2. Download Docker for MacOS depending on your instruction-set (arm vs x86) from https://docs.docker.com/desktop/install/mac-install/

3. Rename the Polykey dist from x-docker-image-polykey-cli-x.x.x-alpha.x.tar.gz to docker-polykey.tar.gz

4. Load the image in docker using the following:

docker load --input docker-polykey.tar.gz

5. Go to your docker application and configure the Polykey image

6. Run mkdir /tmp/polykey to create a directory for the polykey nodepath

7. Set the volume host path to /tmp/polykey and the container path to /tmp/polykey/

8. Run docker images to grab the Image ID of your installed image.

> docker images
REPOSITORY                  TAG                                IMAGE ID       CREATED       SIZE
polykey-cli-0.1.2-alpha.2   gygbx1qgpnhbvbcbaby3sfm19bamg7sx   0e1addd9855a   12 days ago   370MB

9. Now you can run Polykey as an agent with the following shell command

docker run -it 0e1addd9855a agent start --background -np /tmp/polykey

Making sure to replace 0e1addd9855a with your corresponding image ID.

 docker run -it  0e1addd9855a agent start --background -np /tmp/polykey
WARNING: The requested image's platform (linux/amd64) does not match the detected host platform (linux/arm64/v8) and no specific platform was requested
✔ Enter new password … *
✔ Confirm new password … *
pid         	28
nodeId      	vflhiouqt255gq22drpf0s639kl9eds3ralu094c6rsnmonemp6pg
clientHost  	127.0.0.1
clientPort  	45509
agentHost   	::
agentPort   	37468
recoveryCode	net elephant gentle eight pulp oyster panther sing own autumn silly whip simple warfare daughter pepper detail bachelor awkward forget ignore cream silly raw

npm

Node Package Manager

The CLI is published as npm package.

Install it with:

npm install -g polykey-cli

This will install the Polykey-CLI into the path pointed to by the command $(npm config get prefix).

If the npm bin path is added to the $PATH environment variable, then you will be able to execute pk or polykey.

Source

Source

The official source repository is on GitHub. There is an additional mirror on GitLab.

git clone https://github.com/MatrixAI/Polykey-CLI.git

Use npm install to setup the project.

tip

If you have nix-shell available, enter into nix-shell and it will automatically setup the development environment.