Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Update documentation on installing the poktrolld CLI #949

Merged
merged 1 commit into from
Nov 21, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 43 additions & 25 deletions docusaurus/docs/operate/user_guide/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,62 +3,80 @@ 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
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

Expand Down
Loading