|
928 | 928 | <ul class="md-nav__list">
|
929 | 929 |
|
930 | 930 | <li class="md-nav__item">
|
931 |
| - <a href="#download-the-package-for-your-os" class="md-nav__link"> |
| 931 | + <a href="#install-via-binary-package-download" class="md-nav__link"> |
932 | 932 | <span class="md-ellipsis">
|
933 |
| - Download the package for your OS |
| 933 | + Install via Binary Package Download |
934 | 934 | </span>
|
935 | 935 | </a>
|
936 | 936 |
|
937 | 937 | </li>
|
938 | 938 |
|
939 | 939 | <li class="md-nav__item">
|
940 |
| - <a href="#extract-the-binary-and-move-it-to-usrbinlocal" class="md-nav__link"> |
| 940 | + <a href="#install-via-homebrew-macos" class="md-nav__link"> |
941 | 941 | <span class="md-ellipsis">
|
942 |
| - Extract the binary and move it to /usr/bin/local |
943 |
| - </span> |
944 |
| - </a> |
945 |
| - |
946 |
| -</li> |
947 |
| - |
948 |
| - <li class="md-nav__item"> |
949 |
| - <a href="#macosusers" class="md-nav__link"> |
950 |
| - <span class="md-ellipsis"> |
951 |
| - macOSUsers |
| 942 | + Install via Homebrew (macOS) |
952 | 943 | </span>
|
953 | 944 | </a>
|
954 | 945 |
|
|
3459 | 3450 | <ul class="md-nav__list">
|
3460 | 3451 |
|
3461 | 3452 | <li class="md-nav__item">
|
3462 |
| - <a href="#download-the-package-for-your-os" class="md-nav__link"> |
| 3453 | + <a href="#install-via-binary-package-download" class="md-nav__link"> |
3463 | 3454 | <span class="md-ellipsis">
|
3464 |
| - Download the package for your OS |
| 3455 | + Install via Binary Package Download |
3465 | 3456 | </span>
|
3466 | 3457 | </a>
|
3467 | 3458 |
|
3468 | 3459 | </li>
|
3469 | 3460 |
|
3470 | 3461 | <li class="md-nav__item">
|
3471 |
| - <a href="#extract-the-binary-and-move-it-to-usrbinlocal" class="md-nav__link"> |
| 3462 | + <a href="#install-via-homebrew-macos" class="md-nav__link"> |
3472 | 3463 | <span class="md-ellipsis">
|
3473 |
| - Extract the binary and move it to /usr/bin/local |
3474 |
| - </span> |
3475 |
| - </a> |
3476 |
| - |
3477 |
| -</li> |
3478 |
| - |
3479 |
| - <li class="md-nav__item"> |
3480 |
| - <a href="#macosusers" class="md-nav__link"> |
3481 |
| - <span class="md-ellipsis"> |
3482 |
| - macOSUsers |
| 3464 | + Install via Homebrew (macOS) |
3483 | 3465 | </span>
|
3484 | 3466 | </a>
|
3485 | 3467 |
|
@@ -3553,27 +3535,31 @@ <h3 id="windows-users">Windows Users<a class="headerlink" href="#windows-users"
|
3553 | 3535 | </blockquote>
|
3554 | 3536 | <h2 id="install-the-cli">Install the CLI<a class="headerlink" href="#install-the-cli" title="Permanent link">¶</a></h2>
|
3555 | 3537 | <p>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.</p>
|
3556 |
| -<h3 id="download-the-package-for-your-os">Download the package for your OS<a class="headerlink" href="#download-the-package-for-your-os" title="Permanent link">¶</a></h3> |
3557 |
| -<p>Go to the <a href="https://github.com/hyperledger/firefly-cli/releases/latest">latest release page</a> and download the package for your OS and CPU architecture.</p> |
3558 |
| -<h3 id="extract-the-binary-and-move-it-to-usrbinlocal">Extract the binary and move it to <code>/usr/bin/local</code><a class="headerlink" href="#extract-the-binary-and-move-it-to-usrbinlocal" title="Permanent link">¶</a></h3> |
3559 |
| -<p>Assuming you downloaded the package from GitHub into your <code>Downloads</code> directory, run the following command:</p> |
| 3538 | +<h3 id="install-via-binary-package-download">Install via Binary Package Download<a class="headerlink" href="#install-via-binary-package-download" title="Permanent link">¶</a></h3> |
| 3539 | +<p>Download the package for your OS by navigating to the <a href="https://github.com/hyperledger/firefly-cli/releases/latest">latest release page</a> and downloading the appropriate package for your OS and architecture.</p> |
| 3540 | +<h4 id="unpack-and-install-the-binary">Unpack and Install the Binary<a class="headerlink" href="#unpack-and-install-the-binary" title="Permanent link">¶</a></h4> |
| 3541 | +<p>Assuming you downloaded the package from GitHub into your <code>Downloads</code> directory, run the following command to extract the binary and move it to your system path:</p> |
3560 | 3542 | <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>sudo tar -zxf ~/Downloads/firefly-cli_*.tar.gz -C /usr/local/bin ff && rm ~/Downloads/firefly-cli_*.tar.gz
|
3561 | 3543 | </code></pre></div>
|
3562 |
| -<p>If you downloaded the package from GitHub into a different directory, you will need to change the <code>tar</code> command above to wherever the <code>firefly-cli_*.tar.gz</code> file is located.</p> |
3563 |
| -<h3 id="macosusers">macOSUsers<a class="headerlink" href="#macosusers" title="Permanent link">¶</a></h3> |
| 3544 | +<p>If you downloaded the package into a different directory, adjust the command to point to the correct location of the <code>firefly-cli_*.tar.gz</code> file.</p> |
| 3545 | +<h4 id="macosusers">macOSUsers<a class="headerlink" href="#macosusers" title="Permanent link">¶</a></h4> |
3564 | 3546 | <blockquote>
|
3565 | 3547 | <p><strong>NOTE</strong>: 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 <a href="https://github.com/hyperledger/firefly-cli/blob/main/docs/mac_help.md">allow the FireFly CLI in System Preferences</a>, before it will run.</p>
|
3566 | 3548 | </blockquote>
|
| 3549 | +<h3 id="install-via-homebrew-macos">Install via Homebrew (macOS)<a class="headerlink" href="#install-via-homebrew-macos" title="Permanent link">¶</a></h3> |
| 3550 | +<p>You can also install the FireFly CLI using Homebrew:</p> |
| 3551 | +<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>brew install firefly |
| 3552 | +</code></pre></div> |
3567 | 3553 | <h3 id="alternative-installation-method-install-via-go">Alternative installation method: Install via Go<a class="headerlink" href="#alternative-installation-method-install-via-go" title="Permanent link">¶</a></h3>
|
3568 | 3554 | <p>If you have a local Go development environment, and you have included <code>${GOPATH}/bin</code> in your path, you could also use Go to install the FireFly CLI by running:</p>
|
3569 |
| -<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>go<span class="w"> </span>install<span class="w"> </span>github.com/hyperledger/firefly-cli/ff@latest |
| 3555 | +<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>go<span class="w"> </span>install<span class="w"> </span>github.com/hyperledger/firefly-cli/ff@latest |
3570 | 3556 | </code></pre></div>
|
3571 | 3557 | <h2 id="verify-the-installation">Verify the installation<a class="headerlink" href="#verify-the-installation" title="Permanent link">¶</a></h2>
|
3572 | 3558 | <p>After using either installation method above, you can verify that the CLI is successfully installed by running <code>ff version</code>. This should print the current version like this:</p>
|
3573 |
| -<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>{ |
3574 |
| -<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a> "Version": "v0.0.47", |
3575 |
| -<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a> "License": "Apache-2.0" |
3576 |
| -<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a>} |
| 3559 | +<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>{ |
| 3560 | +<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a> "Version": "v0.0.47", |
| 3561 | +<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a> "License": "Apache-2.0" |
| 3562 | +<a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a>} |
3577 | 3563 | </code></pre></div>
|
3578 | 3564 | <h2 id="next-steps-start-your-environment">Next steps: Start your environment<a class="headerlink" href="#next-steps-start-your-environment" title="Permanent link">¶</a></h2>
|
3579 | 3565 | <p>Now that you've got the FireFly CLI set up on your machine, the next step is to create and start a FireFly stack.</p>
|
|
0 commit comments