diff --git a/doc-site/docs/gettingstarted/firefly_cli.md b/doc-site/docs/gettingstarted/firefly_cli.md index 9d0073253..bb26fd574 100644 --- a/doc-site/docs/gettingstarted/firefly_cli.md +++ b/doc-site/docs/gettingstarted/firefly_cli.md @@ -24,24 +24,34 @@ In order to run the FireFly CLI, you will need a few things installed on your de There are several ways to install the FireFly CLI. The easiest way to get up and running with the FireFly CLI is to download a pre-compiled binary of the latest release. -### Download the package for your OS +### Install via Binary Package Download -Go to the [latest release page](https://github.com/hyperledger/firefly-cli/releases/latest) and download the package for your OS and CPU architecture. +Download the package for your OS by navigating to the [latest release page](https://github.com/hyperledger/firefly-cli/releases/latest) and downloading the appropriate package for your OS and architecture. -### Extract the binary and move it to `/usr/bin/local` +#### Unpack and Install the Binary + + +Assuming you downloaded the package from GitHub into your `Downloads` directory, run the following command to extract the binary and move it to your system path: -Assuming you downloaded the package from GitHub into your `Downloads` directory, run the following command: ``` sudo tar -zxf ~/Downloads/firefly-cli_*.tar.gz -C /usr/local/bin ff && rm ~/Downloads/firefly-cli_*.tar.gz ``` -If you downloaded the package from GitHub into a different directory, you will need to change the `tar` command above to wherever the `firefly-cli_*.tar.gz` file is located. +If you downloaded the package into a different directory, adjust the command to point to the correct location of the `firefly-cli_*.tar.gz` file. -### macOSUsers +#### macOSUsers > **NOTE**: On recent versions of macOS, default security settings will prevent the FireFly CLI binary from running, because it was downloaded from the internet. You will need to [allow the FireFly CLI in System Preferences](https://github.com/hyperledger/firefly-cli/blob/main/docs/mac_help.md), before it will run. +### Install via Homebrew (macOS) + +You can also install the FireFly CLI using Homebrew: + +``` +brew install firefly +``` + ### Alternative installation method: Install via Go If you have a local Go development environment, and you have included `${GOPATH}/bin` in your path, you could also use Go to install the FireFly CLI by running: