|
| 1 | +# Install Open Libra CLI pre-built binary |
| 2 | + |
| 3 | +Although it is recommended that users build the the libra CLI tool from source themselves |
| 4 | +[(see this page for details)](./install-open-libra-cli.md), |
| 5 | +a selection of pre-built binaries are generated by the project's GitHub repository's CI workflows. |
| 6 | +These binaries cover the following |
| 7 | +platforms: macos, Linux, Windows and the following CPU architectures: x64 (Intel/AMD) and arm64. |
| 8 | + |
| 9 | +**Warning**: |
| 10 | +Exercise caution when downlading executable binary files. If you are not |
| 11 | +familiar with computer security do not do this without seeking advice from someone who is. |
| 12 | + |
| 13 | +## Installation |
| 14 | +Visit the |
| 15 | +[releases page](https://github.com/0LNetworkCommunity/libra-framework/releases) and identify the |
| 16 | +appropriate binary file for your computer. Download the file then follow platform-specific instructions |
| 17 | +and notes below: |
| 18 | + |
| 19 | +### macos |
| 20 | + |
| 21 | +Note that to use macos pre-built binaries currently, the computer must already have the |
| 22 | +[homebrew package manager](https://brew.sh/) installed. \ |
| 23 | +This is required in order to install a necessary dependency (openssl). |
| 24 | + |
| 25 | +The downloaded file is a "bare binary executable" (rather than an installable package) and as such requires |
| 26 | +additional steps to be usable: |
| 27 | + |
| 28 | +1. Copy the downloladed file to a suitable directory on the shell's path, e.g. `~/bin`, while also change the filename to `libra`: |
| 29 | + ``` |
| 30 | + % cp ~/Downloads/libra-macos-arm64 ~/bin/libra |
| 31 | + ``` |
| 32 | +1. Downloaded files are quarantined, meaning macos will not allow such a file to be run. This is done |
| 33 | +to protect the user from inadvertently downloading and running malicious software. The quarantine status |
| 34 | +can be removed with a command like this: |
| 35 | + ``` |
| 36 | + % xattr -dr com.apple.quarantine ~/bin/libra |
| 37 | + ``` |
| 38 | +1. `libra` requires that the brew package "openssl" is installed. This can be done using homebrew: |
| 39 | + ``` |
| 40 | + % brew install openssl |
| 41 | + ``` |
| 42 | +1. Check that `libra` runs (this should print CLI tool version information without errors): |
| 43 | + ``` |
| 44 | + % libra version |
| 45 | + ``` |
| 46 | +
|
| 47 | +### Windows |
| 48 | +
|
| 49 | +Note that at present there is no arm64 version of the Windows binary file. However Windows arm64 machines will run |
| 50 | +the x64 version. |
| 51 | +
|
| 52 | +The binary files are native Windows executables. Note however that WSL2 users may install and use the relevant Linux |
| 53 | +binary for use within the WSL2 environment (see Linux instructions below). |
| 54 | +
|
| 55 | +1. Copy the downloladed file to a suitable directory on the shell's path, e.g. `%HOMEPATH%\bin`, while also change the filename to `libra.exe`: |
| 56 | + ``` |
| 57 | + C:\Users\anon>copy "Downloads\libra-windows-x64.exe" %HOMEPATH%\bin\libra.exe |
| 58 | + 1 file(s) copied. |
| 59 | + ``` |
| 60 | +1. Check that `libra` runs (this should print CLI tool version information without errors): |
| 61 | + ``` |
| 62 | + C:\Users\anon> libra version |
| 63 | + ``` |
| 64 | +
|
| 65 | +### Linux |
| 66 | +
|
| 67 | +Note that currently binary files are built on Ubuntu 24.04. This means they are not compatible with older Ubuntu releases such as 22.04. |
| 68 | +
|
| 69 | +1. Copy the downloladed file to a suitable directory on the shell's path, e.g. `~/bin`, while also change the filename to `libra`: |
| 70 | + ``` |
| 71 | + $ cp ~/Downloads/libra-linux-x64 ~/bin/libra |
| 72 | + ``` |
| 73 | +1. Mark the file executable: |
| 74 | + ``` |
| 75 | + $ chmod +x ~/bin/libra |
| 76 | + ``` |
| 77 | +1. `libra` requires that the brew package "openssl" is installed. This can be done using apt: |
| 78 | + ``` |
| 79 | + $ sudo apt install openssl |
| 80 | + ``` |
| 81 | +1. Check that `libra` runs (this should print CLI tool version information without errors): |
| 82 | + ``` |
| 83 | + $ libra version |
| 84 | + ``` |
| 85 | +
|
0 commit comments