jeans/etcher
jeans/etcher
1
0
Fork 0
mirror of https://github.com/balena-io/etcher.git synced 2025-07-15 15:26:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(CLI): move the CLI installation instructions to a separate page (#1418)

Browse Source
This commit is contained in:
Andrew Scheller 2017-05-12 13:30:09 +01:00 committed by GitHub
parent 05692b9947
commit b04d7ad8f2
2 changed files with 70 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
docs/CLI-INSTALLATION.md Normal file
View File

@ -0,0 +1,67 @@
macOS and GNU/Linux
-------------------
- Extract the `.tar.gz` package by running:
```sh
tar fvx path/to/cli.tar.gz
```
- Move the resulting directory to `/opt/etcher-cli`
- Add `/opt/etcher-cli` to the `PATH`. For example, add the following to
`.bashrc` or `.zshrc`:
```sh
export PATH="$PATH:/opt/etcher-cli"
```
Windows
-------
- Unzip the `.zip` package by right-clicking on it and selecting "Extract All"
- Move the resulting directory to `C:\etcher-cli`
- Add `C:\etcher-cli` to the `%PATH%`
- On Windows 10 and Windows 8
- Open *Control Panel*
- Open *System
- Click the *Advanced system settings* link
- Click *Environment Variables*
- Find the `PATH` environment variable, and click *Edit*
- Append `;C:\etcher-cli` to the environment variable value
- Click *OK*
- On Windows 7
- Right-click the *My Computer* icon
- Open the *Properties* menu
- Open the *Advanced* tab
- Click *Environment Variables*
- Find the `PATH` environment variable, and click *Edit*
- Append `;C:\etcher-cli` to the environment variable value
- Click *OK*
- Re-open `cmd.exe`, or PowerShell
Running
-------
```sh
etcher -v
```
Options
-------
```
--help, -h show help
--version, -v show version number
--drive, -d drive
--check, -c validate write
--yes, -y confirm non-interactively
--unmount, -u unmount on success
```

53
docs/CLI.md
View File

@ -11,55 +11,8 @@ which is the place where the actual writing logic takes place.
Installing
----------
Head over to [etcher.io][etcher] and download the package that corresponds to
your operating system.
macOS and GNU/Linux
-------------------
- Extract the `.tar.gz` package by running:
```sh
tar fvx path/to/cli.tar.gz
```
- Move the resulting directory to `/opt/etcher-cli`
- Add `/opt/etcher-cli` to the `PATH`. For example, add the following to
`.bashrc` or `.zshrc`:
```sh
export PATH="$PATH:/opt/etcher-cli"
```
Windows
-------
- Unzip the `.zip` package by right-clicking on it and selecting "Extract All"
- Move the resulting directory to `C:\etcher-cli`
- Add `C:\etcher-cli` to the `%PATH%`
- On Windows 10 and Windows 8
- Open *Control Panel*
- Open *System
- Click the *Advanced system settings* link
- Click *Environment Variables*
- Find the `PATH` environment variable, and click *Edit*
- Append `;C:\etcher-cli` to the environment variable value
- Click *OK*
- On Windows 7
- Right-click the *My Computer* icon
- Open the *Properties* menu
- Open the *Advanced* tab
- Click *Environment Variables*
- Find the `PATH` environment variable, and click *Edit*
- Append `;C:\etcher-cli` to the environment variable value
- Click *OK*
- Re-open `cmd.exe`, or PowerShell
Head over to [etcher.io/cli][etcher-cli], download the package that corresponds to
your operating system, and then follow the installation instructions there.
Running
-------
@ -86,4 +39,4 @@ Debug mode
You can set the `ETCHER_CLI_DEBUG` environment variable to make the Etcher CLI
print error stack traces.
[etcher]: https://etcher.io/
[etcher-cli]: https://etcher.io/cli