diff --git a/docusaurus/docs/operate/user_guide/install.md b/docusaurus/docs/operate/user_guide/install.md index ffa17875c..b19473f01 100644 --- a/docusaurus/docs/operate/user_guide/install.md +++ b/docusaurus/docs/operate/user_guide/install.md @@ -3,41 +3,47 @@ title: CLI Installation sidebar_position: 0 --- -- [Release binaries](#release-binaries) -- [Installing from source](#installing-from-source) - - [Prerequisites](#prerequisites) -- [Homebrew and pkgx](#homebrew-and-pkgx) +- [MacOS \& Linux Users](#macos--linux-users) + - [Using Homebrew](#using-homebrew) + - [From Source](#from-source) + - [Using release binaries](#using-release-binaries) - [Windows Users](#windows-users) -## Release binaries +## MacOS & Linux Users -Pre-built binaries are available on our [releases page](https://github.com/pokt-network/poktroll/releases). +### Using Homebrew -The following snippet downloads/upgrades the binary to the latest released version (Linux and macOS only): +:::tip +See the [homebrew-poktroll](https://github.com/pokt-network/homebrew-poktroll/) +repository for details on how to install homebrew or other details to install +or debug the CLI. +::: -```bash -# Download the correct binary based on the OS and architecture -curl -LO "https://github.com/pokt-network/poktroll/releases/latest/download/poktroll_$(uname | tr '[:upper:]' '[:lower:]')_$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/').tar.gz" +Ensure you have [Homebrew](https://brew.sh/) installed. -# Extract the downloaded tarball to /usr/local/bin -sudo tar -zxf "poktroll_$(uname | tr '[:upper:]' '[:lower:]')_$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/').tar.gz" -C /usr/local/bin +Then run the following commands: -# Make the binary executable -sudo chmod +x /usr/local/bin/poktrolld +```bash +brew tap pokt-network/poktroll +brew install poktrolld +``` -# Check version +And verify it worked by running: + +```bash poktrolld version +poktrolld --help ``` -## Installing from source - -### Prerequisites +### From Source Ensure you have the following installed: - [Go](https://go.dev/doc/install) (version 1.18 or later) - [Ignite CLI](https://docs.ignite.com/welcome/install) +Then run the following commands: + ```bash git clone https://github.com/pokt-network/poktroll.git cd poktroll @@ -45,20 +51,32 @@ make go_develop make ignite_poktrolld_build ``` -Verify it worked by running: +And verify it worked by running: ```bash +poktrolld version poktrolld --help ``` -## Homebrew and pkgx +### Using release binaries -:::tip -We have an [open GitHub issue](https://github.com/pokt-network/poktroll/issues/535) -to introduce `poktrolld` to [brew](https://brew.sh/) and [pkgx](https://github.com/pkgxdev/pkgx). +Pre-built binaries are available on our [releases page](https://github.com/pokt-network/poktroll/releases). -Please reach out to us in the ticket if you want to pick this ticket! -::: +The following snippet downloads/upgrades the binary to the latest released version: + +```bash +# Download the correct binary based on the OS and architecture +curl -LO "https://github.com/pokt-network/poktroll/releases/latest/download/poktroll_$(uname | tr '[:upper:]' '[:lower:]')_$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/').tar.gz" + +# Extract the downloaded tarball to /usr/local/bin +sudo tar -zxf "poktroll_$(uname | tr '[:upper:]' '[:lower:]')_$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/').tar.gz" -C /usr/local/bin + +# Make the binary executable +sudo chmod +x /usr/local/bin/poktrolld + +# Check version +poktrolld version +``` ## Windows Users