Files
community-plugins/ssh-launcher/README.md
T
CleboostandGitHub a2b1062856 feat(ssh-launcher): add /ssh launcher for SSH config hosts (#138)
* feat(ssh-launcher): add /ssh launcher for SSH config hosts

Provide a launcher provider that reads ~/.ssh/config, lists host aliases
with fuzzy search, and opens an SSH session in the terminal on activate.

* docs(ssh-launcher): update store thumbnail

Replace the plugin card image with the final SSH Launcher artwork,
blur server IP addresses, and fix the displayed category tags.

* fix(ssh-launcher): parse SSH config directives case-insensitively

Match Host, Hostname, and User keywords regardless of casing so
lowercase blocks are included, consistent with OpenSSH behavior.
2026-07-29 08:48:14 -04:00

41 lines
1.3 KiB
Markdown

# SSH Launcher
![SSH Launcher thumbnail](thumbnail.webp)
SSH Launcher lists hosts from your OpenSSH config and opens an SSH session in a
terminal from the Noctalia launcher.
## Plugin
| Field | Value |
| --- | --- |
| ID | `cleboost/ssh-launcher` |
| Entry | Launcher provider: `launcher` |
| Launcher Prefix | `/ssh` |
## Requirements
Install [OpenSSH](https://www.openssh.com/) and ensure `ssh` is available on
`PATH`.
## Usage
Open the Noctalia launcher and type `/ssh` to list hosts from your SSH config.
Continue typing to filter by host alias, hostname, or user, then select one to
open a terminal running `ssh <host>`.
## Settings
| Setting | Type | Default | Description |
| --- | --- | --- | --- |
| `config_path` | `file` | `~/.ssh/config` | Path to your SSH config file. |
| `max_results` | `int` | `30` | Maximum number of hosts shown. |
| `extra_args` | `string` | `""` | Extra arguments appended to every `ssh` command. |
| `terminal` | `string` | `""` | Custom terminal command. Empty uses Noctalia's terminal discovery. |
## Notes
Hosts are read from simple `Host` entries in your SSH config. Wildcard patterns
such as `Host *` or `Host *.example.com` are ignored. `Include` directives are
not expanded in this version. The host list is cached for the launcher session.