Installing the PDK CLI
Our Provider Development documentation is still a work-in-progress. If you're building an Access Provider, join our Community Slack.
In order to use the pdk
CLI you'll need to install it on your system. Common Fate provides binaries for pdk
that you can download and install.
- Homebrew on MacOS
- Linux
- Windows
Homebrew is an open source package manager for MacOS. We publish a Homebrew formula for pdk
. To install pdk
with Homebrew, run the commands below in your terminal.
brew install common-fate/tap/pdk
Select the steps which match your system architecture. You can find your architecture by running uname -m
from a terminal window.
- x86_64
- arm64
- i386
curl -OL releases.commonfate.io/pdk/v0.3.0/pdk_0.3.0_linux_x86_64.tar.gz
sudo tar -zxvf ./pdk_0.3.0_linux_x86_64.tar.gz -C /usr/local/bin/
curl -OL releases.commonfate.io/pdk/v0.3.0/pdk_0.3.0_linux_arm64.tar.gz
sudo tar -zxvf ./pdk_0.3.0_linux_arm64.tar.gz -C /usr/local/bin/
curl -OL releases.commonfate.io/pdk/v0.3.0/pdk_0.3.0_linux_i386.tar.gz
sudo tar -zxvf ./pdk_0.3.0_linux_i386.tar.gz -C /usr/local/bin/
First, download the zip archive of pdk
which matches your system's architecture. You can find your architecture by viewing your system properties in the Control Panel.
After downloading pdk
, unzip the package.
You'll need to move pdk
to a folder that is accessible on your PATH
. This StackOverflow link has instructions on how to do this.
Verify the installation
You can verify the integrity and authenticity of the pdk
binary you have downloaded by running through the verification process here (replacing references to granted
in URLs with pdk
).
To verify that the installation has succeeded, print the version of pdk
by running pdk -v
. You should see an output similar to below.
➜ pdk -v
pdk v0.3.0