Ian Cleary (iancleary)
Welcome! This is a CLI to generate/update SSH config files for your local virtual machines quickly.
Windows doesn't maintain a static IP Address of Hyper-V Virtual Machines across reboots. When using multipass with a Hyper-V backend, this applies as well for multipass.
This leads to ssh configuration, which is by ip address, to be stale every reboot.
This script updates my ssh config file for me
- get IP address from PowerShell for hyper-v by name according to source ('hyper-v' directly, or 'multipass list')
- write template config files to the
~/.ssh/config.d/directory according to your~/.config/local-ssh-config/settings.jsonfile.
This assumes you have:
- a
~/.ssh/config.d/folder Include config.d/*in your~/.ssh/config- For Hyper-V Virtual Machines
- PowerShell installed
- Hyper-V enabled and The Hyper-V Manager Installed
I currently use Ubuntu Servers, if you do too, please install several
aptpackages in the Virtual Machine (so that Hyper-V can report the IP Address)
🚨🚨 Hyper-V will not report the ip address until you do the above 🚨🚨
Multipass or Virtual Box may report the IP address of an Ubuntu Guest. I'm not currently sure if it's a Hyper-V limitation or a Windows limitation.
As this tool only currently supports Hyper-V, please consider this a warning of the required step.
❯ pipx install local-ssh-config --user
❯ local-ssh-config --helpThat will output the following:
Usage: local_ssh_config [OPTIONS]
Creates an `~/.ssh/config.d/` directory,
checks to see if you include all files in that directory,
and then creates config files for each virtual machine specified
in your `~/.config/vm-ip-ssh-config/settings.json` file.
See https://github.com/iancleary/local-ssh-config/ for more information.
Arguments:
None
Options:
-f, --file TEXT The JSON file containing the virtual machine
configuration [default: C:\Users\username\.config\vm-
ip-ssh-config\settings.json]
-v, --version Show the application's version and exit.
--install-completion Install completion for the current shell.
--show-completion Show completion for the current shell, to copy it or
customize the installation.
--help Show this message and exit.The first and only argument is the name of the component to create.
$ local-ssh-config
{'host': 'test.local', 'hostname': '0.0.0.0', 'user': 'test', 'identity_file': '~/.ssh/example_id_ed25519'}
{'host': 'ubuntu.local', 'hostname': {'source': 'hyper-v', 'physical_address': '00-15-5d-95-fb-09'}, 'user': 'icleary', 'identity_file': '~/.ssh/github_id_rsa_ed25519'}
Hyper-V: Powershell (arp -a): Interface command executed successfully!
-------------------------
{'host': 'dev1.multipass.local', 'hostname': {'source': 'multipass', 'name': 'dev1'}, 'user': 'ubuntu'}
Multipass-V: Powershell (multipass list): Interface command executed successfully!
-------------------------
✨ Creating ~/.ssh/config.d/ files
✅ C:\Users\icleary\.ssh\config.d\test.local
✅ C:\Users\icleary\.ssh\config.d\ubuntu.local
✅ C:\Users\icleary\.ssh\config.d\dev1.multipass.local
SSH config updated! 🚀 ✨!
Thank you for using local-ssh-config.The path printed is the absolute path to the updated config files.
This uses a directory
~/.ssh/config.d/to allow for a single file per Host, to allow cleaner version tracking within a dotfile manager. SeeInclude config.d/*in your~/.ssh/configfor the include syntax WINDOWS_MULTIPASS_DEFAULT_ID_RSA = "%PROGRAMDATA%/Multipass/data/ssh-keys/id_rsa"
Configuration can be done through 2 different ways:
- Creating a global
settings.jsonin your home directory (~/.config/local-ssh-config/settings.json). - Creating a local
.local-ssh-config-config.jsonin your project's root directory and including the path to that file with the--for-foptionanl command-line argument.
The optional command line value takes precendence global settings file being the default.
Controls the settings.json to load.
Defaults to ~/.config/local-ssh-config/settings.json
Usage:
Command line: --file <value> or -f <value>
JSON config:
Example with single host, as dictionary
{
"host": "ubuntu.local",
"hostname": {
"source": "hyper-v",
"physical_address": "00-15-5d-95-fb-09"
},
"user": "icleary",
"identity_file": "~/.ssh/github_id_rsa_ed25519"
}Example with single host, as list:
[
{
"host": "ubuntu.local",
"hostname": {
"source": "hyper-v",
"physical_address": "00-15-5d-95-fb-09"
},
"user": "icleary",
"identity_file": "~/.ssh/github_id_rsa_ed25519"
}
]A single dictionary is converted to a list of hosts before looping through the files, so either structure is valid (your preference).
Example with multiple hosts:
[
{
"host": "test.local",
"hostname": "0.0.0.0",
"user": "test",
"identity_file": "~/.ssh/example_id_ed25519"
},
{
"host": "ubuntu.local",
"hostname": {
"source": "hyper-v",
"physical_address": "00-15-5d-95-fb-09"
},
"user": "icleary",
"identity_file": "~/.ssh/github_id_rsa_ed25519"
},
{
"host": "dev1.multipass.local",
"hostname": {
"source": "multipass",
"name": "dev1"
},
"user": "ubuntu"
}
]I will likely evolve this CLI as I learn more; I'm on my way 😊
Enjoy quickly updating your ssh configurations 🚀!
I created this CLI for my opinionated uses and may not accept changes. That said, I made this to solve a problem, and if you have the same problem, I hope it helps you! 😊
See CONTRIBUTING.md.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent