From ca60e30171e2ea142ac91aa8747bac083c1942a5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mislav=20Marohni=C4=87?= Date: Tue, 17 Aug 2021 11:46:25 +0200 Subject: [PATCH 1/4] Add warning about Snap --- docs/install_linux.md | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/docs/install_linux.md b/docs/install_linux.md index 676f24323..759c87d22 100644 --- a/docs/install_linux.md +++ b/docs/install_linux.md @@ -83,6 +83,10 @@ Install and upgrade: The core GitHub CLI team does not maintain the following packages or repositories. They are unofficial and we are unable to provide support or guarantees for them. They are linked here as a convenience and their presence does not imply continued oversight from the CLI core team. Users who choose to use them do so at their own risk. +### Snap (do not use) + +There are [so many issues with Snap](https://github.com/casperdcl/cli/issues/7) as a runtime mechanism for apps like GitHub CLI that our team suggests _never installing gh as a snap_. + ### Arch Linux Arch Linux users can install from the [community repo][arch linux repo]: @@ -175,18 +179,6 @@ openSUSE Tumbleweed users can install from the [official distribution repo](http sudo zypper in gh ``` -### Snaps - -Many Linux distro users can install using Snapd from the [Snap Store](https://snapcraft.io/gh) or the associated [repo](https://github.com/casperdcl/cli/tree/snap) - -```bash -sudo snap install --edge gh && snap connect gh:ssh-keys -``` -> Snaps are auto-updated every 6 hours. `Snapd` is required and is available on a wide range of Linux distros. -> Find out which distros have Snapd pre-installed and how to install it in the [Snapcraft Installation Docs](https://snapcraft.io/docs/installing-snapd) -> -> **Note:** `snap connect gh:ssh-keys` is needed for all authentication and SSH needs. - [releases page]: https://github.com/cli/cli/releases/latest [arch linux repo]: https://www.archlinux.org/packages/community/x86_64/github-cli [arch linux aur]: https://aur.archlinux.org/packages/github-cli-git From 1ec632b1b86c047638cfba474c0c35e6bcc9d81c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mislav=20Marohni=C4=87?= Date: Tue, 17 Aug 2021 11:47:21 +0200 Subject: [PATCH 2/4] Add OpenBSD instructions --- README.md | 4 ++-- docs/install_linux.md | 10 +++++++++- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 49d11ff70..71630a5cc 100644 --- a/README.md +++ b/README.md @@ -41,11 +41,11 @@ If anything feels off, or if you feel that some functionality is missing, please Additional Conda installation options available on the [gh-feedstock page](https://github.com/conda-forge/gh-feedstock#installing-gh). -### Linux +### Linux & BSD `gh` is available via [Homebrew](#homebrew), [Conda](#Conda), and as downloadable binaries from the [releases page][]. -For more information and distro-specific instructions, see the [Linux installation docs](./docs/install_linux.md). +For instructions on specific distributions and package managers, see [Linux & BSD installation](./docs/install_linux.md). ### Windows diff --git a/docs/install_linux.md b/docs/install_linux.md index 759c87d22..33192ac64 100644 --- a/docs/install_linux.md +++ b/docs/install_linux.md @@ -1,4 +1,4 @@ -# Installing gh on Linux and FreeBSD +# Installing gh on Linux and BSD Packages downloaded from https://cli.github.com or from https://github.com/cli/cli/releases are considered official binaries. We focus on popular Linux distros and @@ -126,6 +126,14 @@ Or via [pkg(8)](https://www.freebsd.org/cgi/man.cgi?pkg(8)): pkg install gh ``` +### OpenBSD + +In -current, or in releases starting from 7.0, OpenBSD users can install from packages: + +``` +pkg_add github-cli +``` + ### Funtoo Funtoo Linux has an autogenerated github-cli package, located in [dev-kit](https://github.com/funtoo/dev-kit/tree/1.4-release/dev-util/github-cli), which can be installed in the following way: From 0366e047e21ba23efea67e7cf101231cb7cb58d8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mislav=20Marohni=C4=87?= Date: Tue, 17 Aug 2021 11:47:37 +0200 Subject: [PATCH 3/4] Cleanup Linux installation docs --- docs/install_linux.md | 26 +++----------------------- 1 file changed, 3 insertions(+), 23 deletions(-) diff --git a/docs/install_linux.md b/docs/install_linux.md index 33192ac64..1f3d0a5d2 100644 --- a/docs/install_linux.md +++ b/docs/install_linux.md @@ -7,16 +7,10 @@ the following CPU architectures: `i386`, `amd64`, `arm64`, `armhf`. Other sources for installation are community-maintained and thus might lag behind our release schedule. -If none of our official binaries, packages, repositories, nor community sources work for you, we recommend using our `Makefile` to build `gh` from source. It's quick and easy. - ## Official sources ### Debian, Ubuntu Linux (apt) -:warning: This will only work for the [architectures we officially support](/.goreleaser.yml#L27). - -The below should work for any debian-based distribution. You can change `stable` to a specific codename [we support](/.github/workflows/releases.yml#L83) if that is your preference. - Install: ```bash @@ -26,7 +20,7 @@ sudo apt update sudo apt install gh ``` -**Note**: If you get _"gpg: failed to start the dirmngr '/usr/bin/dirmngr': No such file or directory"_ error, try installing the `dirmngr` package. Run `sudo apt-get install dirmngr` and repeat the steps above. +**Note**: If you get the error _"gpg: failed to start the dirmngr '/usr/bin/dirmngr': No such file or directory"_, try installing the `dirmngr` package: `sudo apt install dirmngr`. Upgrade: @@ -72,16 +66,9 @@ sudo zypper update gh * [Download release binaries][releases page] that match your platform; or * [Build from source](./source.md). -### openSUSE/SUSE Linux (zypper) - -Install and upgrade: +## Unofficial, community-supported methods -1. Download the `.rpm` file from the [releases page][]; -2. Install the downloaded file: `sudo zypper in gh_*_linux_amd64.rpm` - -## Unofficial, Community-supported methods - -The core GitHub CLI team does not maintain the following packages or repositories. They are unofficial and we are unable to provide support or guarantees for them. They are linked here as a convenience and their presence does not imply continued oversight from the CLI core team. Users who choose to use them do so at their own risk. +The GitHub CLI team does not maintain the following packages or repositories and thus we are unable to provide support for those installation methods. ### Snap (do not use) @@ -105,13 +92,6 @@ Android 7+ users can install via [Termux](https://wiki.termux.com/wiki/Main_Page pkg install gh ``` -### Homebrew (Linuxbrew) - -Linuxbrew users can install it as a [brew package](https://formulae.brew.sh/formula/gh#default): -```bash -brew install gh -``` - ### FreeBSD FreeBSD users can install from the [ports collection](https://www.freshports.org/devel/gh/): From 810c42120aa4ffb5ebba439ee77e160f2bcb7cdb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mislav=20Marohni=C4=87?= Date: Tue, 17 Aug 2021 12:16:59 +0200 Subject: [PATCH 4/4] Add installation note about Raspberry Pi OS --- docs/install_linux.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/install_linux.md b/docs/install_linux.md index 1f3d0a5d2..c14273d5d 100644 --- a/docs/install_linux.md +++ b/docs/install_linux.md @@ -9,7 +9,7 @@ our release schedule. ## Official sources -### Debian, Ubuntu Linux (apt) +### Debian, Ubuntu Linux, Raspberry Pi OS (apt) Install: