Skip to content

Commit 30643ba

Browse files
committed
Update CLI docs for SSH command & config
1 parent b3de674 commit 30643ba

File tree

2 files changed

+32
-1
lines changed

2 files changed

+32
-1
lines changed

docs/cli/ssh/command.rst

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,18 @@ Options
3232

3333
The username to use when connecting
3434

35+
.. option:: --no-user
36+
37+
Don't include a username in SSH command
38+
3539
.. option:: --help
3640

3741
Show this message and exit
3842

3943
Usage
4044
=====
4145

42-
Output the IPv4 SSH command for a Pi:
46+
Output the default IPv4 SSH command for a Pi:
4347

4448
.. code-block:: console
4549
@@ -53,13 +57,24 @@ Output the IPv4 SSH command for a Pi, with a custom username:
5357
$ hostedpi ssh command mypi --username pi
5458
ssh -p 5091 [email protected]
5559
60+
Output the IPv4 SSH command for a Pi, with no specified username:
61+
62+
.. code-block:: console
63+
64+
$ hostedpi ssh command mypi --no-user
65+
ssh -p 5091 ssh.mypi.hostedpi.com
66+
5667
Output the IPv6 SSH command for a Pi:
5768

5869
.. code-block:: console
5970
6071
$ hostedpi ssh command mypi --ipv6
6172
6273
74+
.. warning::
75+
76+
You will need IPv6 connectivity to connect using the IPv6 address.
77+
6378
Output the IPv6 SSH command for a Pi, with a custom username and numeric address:
6479

6580
.. code-block:: console

docs/cli/ssh/config.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@ Options
3636

3737
The username to use when connecting
3838

39+
.. option:: --no-user
40+
41+
Don't include a username in SSH command
42+
3943
.. option:: --help
4044

4145
Show this message and exit
@@ -71,6 +75,10 @@ Output the IPv6 SSH config for a Pi:
7175
user root
7276
hostname mypi.hostedpi.com
7377
78+
.. warning::
79+
80+
You will need IPv6 connectivity to connect using the IPv6 address.
81+
7482
Output the IPv6 SSH config for a Pi, using a custom username and numeric address:
7583

7684
.. code-block:: console
@@ -80,6 +88,14 @@ Output the IPv6 SSH config for a Pi, using a custom username and numeric address
8088
user pi
8189
hostname 2a00:1098:8:14b::1
8290
91+
Output the IPv6 SSH config for a Pi, using the numeric address and specifying no username:
92+
93+
.. code-block:: console
94+
95+
$ hostedpi ssh config mypi --ipv6 --numeric --no-user
96+
Host mypi
97+
hostname 2a00:1098:8:14b::1
98+
8399
Output the IPv4 SSH config for multiple Pis:
84100

85101
.. code-block:: console

0 commit comments

Comments
 (0)