Skip to content

Commit fc405b4

Browse files
CopilotAkihiroSuda
andcommitted
Make SSH documentation more concise
Co-authored-by: AkihiroSuda <[email protected]>
1 parent d4a5454 commit fc405b4

File tree

2 files changed

+5
-26
lines changed

2 files changed

+5
-26
lines changed

website/content/en/docs/usage/_index.md

Lines changed: 2 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -61,41 +61,17 @@ $ ssh -F /Users/example/.lima/default/ssh.config lima-default
6161

6262
#### Using SSH without the `-F` flag
6363

64-
For easier SSH access, you can configure your `~/.ssh/config` to automatically include Lima's SSH configurations:
64+
To connect directly without specifying the config file, add this to your `~/.ssh/config`:
6565

6666
```
6767
Include ~/.lima/*/ssh.config
6868
```
6969

70-
Add this line to the beginning of your `~/.ssh/config` file. If you have existing `Host` entries in your SSH config, you may need to use the following format instead:
71-
72-
```
73-
Match all
74-
Include ~/.lima/*/ssh.config
75-
```
76-
77-
After adding this configuration, you can connect to Lima instances directly:
78-
70+
Then you can connect directly:
7971
```bash
80-
# Connect to the default instance
8172
ssh lima-default
82-
83-
# Connect to a named instance
84-
ssh lima-ubuntu
85-
86-
# Use SSH with other tools
87-
rsync -a -e ssh . lima-default:/tmp/repo
8873
```
8974

90-
This SSH integration also enables Lima instances to work seamlessly with various tools:
91-
92-
- **VSCode**: Use the Remote-SSH extension to connect to `lima-{NAME}`
93-
- **Ansible**: Target Lima instances using their SSH hostnames in inventory files
94-
- **SFTP**: Transfer files using `sftp lima-{NAME}`
95-
- **SSHFS**: Mount remote filesystems with `sshfs lima-{NAME}: /local/mountpoint`
96-
97-
> **Note**: SSHFS may have limitations on non-Linux platforms like macOS and Windows.
98-
9975
### Shell completion
10076
- To enable bash completion, add `source <(limactl completion bash)` to `~/.bash_profile`.
10177
- To enable zsh completion, see `limactl completion zsh --help`

website/go.sum

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1+
github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
12
github.com/FortAwesome/Font-Awesome v0.0.0-20240716171331-37eff7fa00de h1:JvHOfdSqvArF+7cffH9oWU8oLhn6YFYI60Pms8M/6tI=
23
github.com/FortAwesome/Font-Awesome v0.0.0-20240716171331-37eff7fa00de/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
34
github.com/google/docsy v0.11.0 h1:QnV40cc28QwS++kP9qINtrIv4hlASruhC/K3FqkHAmM=
45
github.com/google/docsy v0.11.0/go.mod h1:hGGW0OjNuG5ZbH5JRtALY3yvN8ybbEP/v2iaK4bwOUI=
56
github.com/google/docsy/dependencies v0.7.2 h1:+t5ufoADQAj4XneFphz4A+UU0ICAxmNaRHVWtMYXPSI=
67
github.com/google/docsy/dependencies v0.7.2/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4=
8+
github.com/twbs/bootstrap v5.2.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
9+
github.com/twbs/bootstrap v5.3.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
710
github.com/twbs/bootstrap v5.3.6+incompatible h1:efmXVyq839m5QQ0+JBUdQQ1TrmoBqvQ5kRhUueKsH+4=
811
github.com/twbs/bootstrap v5.3.6+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=

0 commit comments

Comments
 (0)