Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -282,6 +282,10 @@ 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.

## Command Line Interface

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 💻

### From the terminal
Expand Down
39 changes: 39 additions & 0 deletions docs/cli.md
Original file line number Diff line number Diff line change
@@ -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] <url> 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
```
Loading