From 2ce38297bb241c53f7ccabe05e6e4e6a500205fa Mon Sep 17 00:00:00 2001 From: Guillem Poy Date: Mon, 6 Apr 2026 12:02:54 +0200 Subject: [PATCH 1/2] Add CLI alias instructions to README Co-Authored-By: Claude Opus 4.6 (1M context) --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/README.md b/README.md index f3224f0b452..ea92f11f3b0 100644 --- a/README.md +++ b/README.md @@ -282,6 +282,43 @@ Finally, double-click the .AppImage file to run it. Before opening a new issue, please check the [Known Issues](docs/known-issues.md) document for common issues and their workarounds. +## Creating a CLI alias + +The CLI command `github-desktop-plus-cli` can be long to type. You can create a shorter alias (e.g. `github-plus`) in your shell: + +
+Windows (PowerShell) + +Add this line to your PowerShell profile (open it with `notepad $PROFILE`): + +```powershell +Set-Alias github-plus github-desktop-plus-cli +``` + +
+ +
+macOS / Linux (Bash or Zsh) + +Add this line to your `~/.bashrc` or `~/.zshrc`: + +```bash +alias github-plus='github-desktop-plus-cli' +``` + +
+ +
+macOS / Linux (Fish) + +Run once: + +```fish +alias --save github-plus github-desktop-plus-cli +``` + +
+ ## Running the app locally 💻 ### From the terminal From b7dec04df3e0c6497f0d10c65578f1e0a3c03b3e Mon Sep 17 00:00:00 2001 From: Guillem Poy Date: Mon, 6 Apr 2026 12:15:47 +0200 Subject: [PATCH 2/2] Move CLI docs to separate file, add usage showcase and alias instructions Co-Authored-By: Claude Opus 4.6 (1M context) --- README.md | 37 ++----------------------------------- docs/cli.md | 39 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 41 insertions(+), 35 deletions(-) create mode 100644 docs/cli.md diff --git a/README.md b/README.md index ea92f11f3b0..36b7ea6cfcf 100644 --- a/README.md +++ b/README.md @@ -282,42 +282,9 @@ Finally, double-click the .AppImage file to run it. Before opening a new issue, please check the [Known Issues](docs/known-issues.md) document for common issues and their workarounds. -## Creating a CLI alias +## Command Line Interface -The CLI command `github-desktop-plus-cli` can be long to type. You can create a shorter alias (e.g. `github-plus`) in your shell: - -
-Windows (PowerShell) - -Add this line to your PowerShell profile (open it with `notepad $PROFILE`): - -```powershell -Set-Alias github-plus github-desktop-plus-cli -``` - -
- -
-macOS / Linux (Bash or Zsh) - -Add this line to your `~/.bashrc` or `~/.zshrc`: - -```bash -alias github-plus='github-desktop-plus-cli' -``` - -
- -
-macOS / Linux (Fish) - -Run once: - -```fish -alias --save github-plus github-desktop-plus-cli -``` - -
+GitHub Desktop Plus includes a CLI (`github-desktop-plus-cli`) for opening and cloning repositories from the terminal. See the [CLI documentation](docs/cli.md) for usage details and instructions on creating a shorter alias. ## Running the app locally 💻 diff --git a/docs/cli.md b/docs/cli.md new file mode 100644 index 00000000000..7f9fd6304b9 --- /dev/null +++ b/docs/cli.md @@ -0,0 +1,39 @@ +# Command Line Interface + +GitHub Desktop Plus includes a CLI that lets you open repositories and clone them directly from the terminal. + +## Usage + +``` +github-desktop-plus-cli Open the current directory +github-desktop-plus-cli open [path] Open the provided path +github-desktop-plus-cli clone [-b branch] Clone a repository by URL or name/owner (e.g. torvalds/linux) +``` + +## Creating a shorter alias + +If you find `github-desktop-plus-cli` too long to type, you can create a shorter alias in your shell (e.g. `github-plus`, or even just `github`): + +### Windows (PowerShell) + +Add this line to your PowerShell profile (open it with `notepad $PROFILE`): + +```powershell +Set-Alias github-plus github-desktop-plus-cli +``` + +### macOS / Linux (Bash or Zsh) + +Add this line to your `~/.bashrc` or `~/.zshrc`: + +```bash +alias github-plus='github-desktop-plus-cli' +``` + +### macOS / Linux (Fish) + +Run once: + +```fish +alias --save github-plus github-desktop-plus-cli +```