Skip to content

Commit

Permalink
doc: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
isometry committed Dec 30, 2022
1 parent 98c6727 commit 9737772
Showing 1 changed file with 3 additions and 9 deletions.
12 changes: 3 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,19 @@ A workflow for [Alfred](http://www.alfredapp.com/) Powerpack users to rapidly op

- [v1.3 for Alfred 2.4+](https://github.com/isometry/alfred-ssh/releases/tag/v1.3)
- [v2.3 for Alfred 3.1+](https://github.com/isometry/alfred-ssh/releases/tag/v2.3)
- [v3.x for Alfred 4.0+](https://github.com/isometry/alfred-ssh/releases/latest)
- [v3.x for Alfred 4.0+](https://github.com/isometry/alfred-ssh/releases/tag/v3.1)
- [v4.x for Alfred 5.0+](https://github.com/isometry/alfred-ssh/releases/latest)

## Prerequisites

- [Alfred](http://www.alfredapp.com/) (version 2.4+/3.1+/4.0+)
- [Alfred](http://www.alfredapp.com/) (version 2.4+/3.1+/4.0+/5.0+)
- The [Alfred Powerpack](http://www.alfredapp.com/powerpack/).
- Python3 for v3.x+ (most easily installed/maintained with `sudo xcode-select --install` or [Homebrew](https://brew.sh/))
- (optional) [pybonjour](https://pypi.python.org/pypi/pybonjour)

## Usage

Type `ssh` in Alfred followed by either a literal hostname or by some letters from the hostname of a host referenced in any of `~/.ssh/known_hosts`, `~/.ssh/config`, `/etc/hosts`, or (with `pybonjour` installed) Bonjour.

Alfred 3+ only: workflow configuration is available by setting/changing Workflow Environment Variables (accessed via the [𝓍] button within the workflow):

- disable unwanted sources by setting the associated Workflow Environment Variable to 0; e.g. `alfredssh_known_hosts`, `alfredssh_ssh_config`, `alfredssh_hosts`, `alfredssh_bonjour`.
- change the maximum number of returned results by changing `alfredssh_max_results` (default=36).
- add additional files listing valid host completions (e.g. for pre-seeding) by adding space-separated short-name=~/file/path entries to the `alfredssh_extra_files` Workflow Environment Variable. Lines beginning with `#` are ignored, all other whitespace separated words are assumed to be valid hostnames.

If you wish to have [iTerm2](https://www.iterm2.com/) act as ssh protocol handler rather than Terminal.app, create a new iTerm2 profile with “Name” `$$USER$$@$$HOST$$`, “Command” `$$` and “Schemes handled” `ssh` (e.g. [here](http://apple.stackexchange.com/questions/28938/set-iterm2-as-the-ssh-url-handler) and [here](http://www.alfredforum.com/topic/826-ssh-with-smart-hostname-autocompletion/#entry4147)).

## Contributions & Thanks
Expand Down

0 comments on commit 9737772

Please sign in to comment.