ExternalVendorCode/balena-cli
1
0
Fork 0
mirror of https://github.com/balena-io/balena-cli.git synced 2024-12-18 21:27:51 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Clarify installation instructions

Browse Source 
Change-type: patch
This commit is contained in:
Paulo Castro 2021-08-27 22:30:59 +01:00
parent 08ee8643cb
commit 3fd5981085
3 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
INSTALL-LINUX.md
View File

@ -1,6 +1,10 @@
# balena CLI Installation Instructions for Linux # balena CLI Installation Instructions for Linux
These instructions are suitable for most Linux distributions on Intel x86, except notably for **Linux Alpine** or **Busybox**. For these distros or for the ARM architecture, follow the [NPM Installation](./INSTALL-ADVANCED.md#npm-installation) method. These instructions are suitable for most Linux distributions on Intel x86, such as
Ubuntu, Debian, Fedora, Arch Linux and other glibc-based distributions.
For the ARM architecture and for Linux distributions not based on glibc, such as
Alpine Linux, follow the [NPM Installation](./INSTALL-ADVANCED.md#npm-installation)
method.
Selected operating system: **Linux** Selected operating system: **Linux**

16
INSTALL-MAC.md
View File

@ -10,16 +10,14 @@ Selected operating system: **macOS**
Look for a file name that ends with "-installer.pkg": Look for a file name that ends with "-installer.pkg":
`balena-cli-vX.Y.Z-macOS-x64-installer.pkg` `balena-cli-vX.Y.Z-macOS-x64-installer.pkg`
2. Double click the downloaded file to run the installer. After the installation completes, 2. Double click on the downloaded file to run the installer and follow the installer's
close and re-open any open [command instructions.
terminal](https://www.balena.io/docs/reference/cli/#choosing-a-shell-command-promptterminal)
windows (so that the changes made by the installer to the PATH environment variable can take
effect).
3. Check that the installation was successful by running the following commands on a 3. Check that the installation was successful:
command terminal: - [Open the Terminal
* `balena version` - should print the CLI's version app](https://support.apple.com/en-gb/guide/terminal/apd5265185d-f365-44cb-8b09-71a064a42125/mac).
* `balena help` - should print a list of available commands - On the terminal prompt, type `balena version` and hit Enter. It should display
the version of the balena CLI that you have installed.
No further steps are required to run most CLI commands. The `balena ssh`, `build`, `deploy` No further steps are required to run most CLI commands. The `balena ssh`, `build`, `deploy`
and `preload` commands may require additional software to be installed, as described and `preload` commands may require additional software to be installed, as described

16
INSTALL-WINDOWS.md
View File

@ -10,16 +10,14 @@ Selected operating system: **Windows**
Look for a file name that ends with "-installer.exe": Look for a file name that ends with "-installer.exe":
`balena-cli-vX.Y.Z-windows-x64-installer.exe` `balena-cli-vX.Y.Z-windows-x64-installer.exe`
2. Double click the downloaded file to run the installer. After the installation completes, 2. Double click on the downloaded file to run the installer and follow the installer's
close and re-open any open [command instructions.
terminal](https://www.balena.io/docs/reference/cli/#choosing-a-shell-command-promptterminal)
windows (so that the changes made by the installer to the PATH environment variable can take
effect).
3. Check that the installation was successful by running the following commands on a 3. Check that the installation was successful:
command terminal: - Click on the Windows Start Menu, type PowerShell, and then click
* `balena version` - should print the CLI's version on Windows PowerShell.
* `balena help` - should print a list of available commands - On the command prompt, type `balena version` and hit Enter. It should display
the version of the balena CLI that you have installed.
No further steps are required to run most CLI commands. The `balena ssh`, `scan`, `build`, No further steps are required to run most CLI commands. The `balena ssh`, `scan`, `build`,
`deploy` and `preload` commands may require additional software to be installed, as `deploy` and `preload` commands may require additional software to be installed, as