pocketd CLI Installation
To install pocketd
on Linux or MacOS, run:
curl -sSL https://raw.githubusercontent.com/pokt-network/poktroll/main/tools/scripts/pocketd-install.sh | bash
To upgrade pocketd
to the latest version, run:
curl -sSL https://raw.githubusercontent.com/pokt-network/poktroll/main/tools/scripts/pocketd-install.sh | bash -s -- --upgrade
Table of Contents
- Bash Install Script (Linux & MacOS)
- Homebrew (MacOS only)
- Alternative Methods
- Windows (why!?)
- Publishing a new
pocketd
release
Bash Install Script (Linux & MacOS)
Easiest, fastest way to get started that works on both Linux and MacOS.
curl -sSL https://raw.githubusercontent.com/pokt-network/poktroll/main/tools/scripts/pocketd-install.sh | bash
Verify installation:
pocketd version
pocketd --help
Homebrew (MacOS only)
For MacOS users who prefer Homebrew.
brew tap pokt-network/poktroll
brew install pocketd
Troubleshooting Homebrew
If you have problems installing or upgrading pocketd
via Homebrew:
brew update
brew upgrade pocketd
If it's still not working, try:
brew tap --repair
brew untap pokt-network/poktroll
brew uninstall pocketd
brew tap pokt-network/poktroll
brew install pocketd
The source code for the Homebrew formula can be found at homebrew-pocketd.
Alternative Methods
Using release binaries
- Download the binary from the latest release
- Choose the correct
pocket_${OS}_${ARCH}.tar.gz
for your system - Untar and move the binary to
/usr/local/bin
# Download the correct binary for your OS and architecture
curl -LO "https://github.com/pokt-network/poktroll/releases/latest/download/pocket_$(uname | tr '[:upper:]' '[:lower:]')_$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/').tar.gz"
# Extract to /usr/local/bin
sudo tar -zxf "pocket_$(uname | tr '[:upper:]' '[:lower:]')_$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/').tar.gz" -C /usr/local/bin
# Make it executable
sudo chmod +x /usr/local/bin/pocketd
# Check version
pocketd version
Additional references and links:
- Pre-built binaries can be found on the releases page
- Latest release can be found here
From Source (danger zone)
Do not continue unless you're a 🚀👨💻💎
For ADVANCED users only. Requires developer tools.
Installation dependencies
- Go (v1.23+)
- Make
- Ignite CLI
Build from source
# Clone the repository
git clone https://github.com/pokt-network/poktroll.git pocket
cd pocket
# Optional: Checkout a specific version (recommended)
# Replace v0.0.12 with your desired version from https://github.com/pokt-network/poktroll/releases
git checkout v0.0.12
# Build the binary
make go_develop
make ignite_pocketd_build
Verify installation:
pocketd version
pocketd --help
Windows (why!?)
- Native Windows installation is not supported.
- Use Windows Subsystem for Linux (WSL)
- Follow the Linux install instructions above.
Publishing a new pocketd
release
This section is intended for core protocol developers only.
This section is intended only for core protocol developers.
It is also only intended for for dev releases of the pocketd
CLI.
If you are publishing an official protocol upgrade accompanies by a CLI update, visit the release procedure docs.
:::
1. Create a new dev
git tag
# Clone the repository if you haven't already
git clone git@github.com:pokt-network/poktroll.git poktroll
cd poktroll
# Create a new dev git tag and follow the on-screen instructions
make release_tag_dev
# Push the tag to GitHub
git push origin $(git tag)
2. Draft a new GitHub release
Draft a new release at pokt-network/poktroll/releases/new using the tag (e.g. v0.1.12-dev3
) created in the previous step.
Make sure to mark as a pre-release
and use the auto-generated release notes for simplicity.
3. Wait for the release artifacts to be built (5 - 20 minutes)
The release artifacts workflow will automatically build and publish the release artifacts to GitHub.
Wait for the release artifacts to be built and published to GitHub.
The artifacts will be attached an an Asset
to your release once the workflow completes.
4. Verify via the pocketd-install.sh
script
curl -sSL https://raw.githubusercontent.com/pokt-network/poktroll/main/tools/scripts/pocketd-install.sh | bash -s -- --tag v0.1.12-dev3 --upgrade