Skip to content

Commit 9b7bba1

Browse files
committed
Update generated docs for 3.18.0
1 parent 57659a7 commit 9b7bba1

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,21 @@ To install the latest version, use:
1414
gh extension install github.com/github/gh-es
1515
```
1616

17-
Please make sure to install the correct version of the CLI extension which matches the release version (e.g. `3.17.0`) of your GHES installation, by pinning to the latest patch for the corresponding release series:
17+
Please make sure to install the correct version of the CLI extension which matches the release version (e.g. `3.18.0`) of your GHES installation, by pinning to the latest patch for the corresponding release series:
1818

1919
```bash
20-
gh extension install github.com/github/gh-es --pin v3.17.0
20+
gh extension install github.com/github/gh-es --pin v3.18.0
2121
```
2222

2323
## Supported versions
2424

2525
The following versions of GHES are supported by this CLI. Please refer to the [USAGE](./USAGE.md) for more information on how to use the CLI commands of each release.
2626

27-
* [3.13](https://github.com/github/gh-es/blob/3.13/README.md)
2827
* [3.14](https://github.com/github/gh-es/blob/3.14/README.md)
2928
* [3.15](https://github.com/github/gh-es/blob/3.15/README.md)
3029
* [3.16](https://github.com/github/gh-es/blob/3.16/README.md)
31-
* [3.17](https://github.com/github/gh-es/blob/main/README.md)
30+
* [3.17](https://github.com/github/gh-es/blob/3.17/README.md)
31+
* [3.18](https://github.com/github/gh-es/blob/main/README.md)
3232

3333
## Usage
3434

USAGE.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ Configures the CLI to be able to connect with the Manage GitHub Enterprise Serve
2727
<dt><code>-p</code>, <code>--password &lt;string&gt;</code></dt>
2828
<dd>Password to authenticate with</dd>
2929

30+
<dt><code>-P</code>, <code>--port &lt;int&gt;</code></dt>
31+
<dd>Custom port for the GHES API (default 8443). Only set this if the default management port is inaccessible, e.g. behind a bastion host.</dd>
32+
3033
<dt><code>-r</code>, <code>--reset</code></dt>
3134
<dd>Use to reset and delete the currently configured CLI credentials locally</dd>
3235

@@ -59,6 +62,9 @@ $ gh es configure
5962
# Configure the CLI and provide credentials as flags
6063
$ gh es configure --hostname ghes.github.net --auth-type "root site administrator" --password passworD1
6164

65+
# Configure the CLI and provide a custom port
66+
$ gh es configure --hostname ghes.github.net --port 9443 --auth-type "root site administrator" --password passworD1
67+
6268
# View the current status of the local CLI configuration and verify the connection
6369
$ gh es configure --status
6470

0 commit comments

Comments
 (0)