beliven-it / hssh Goto Github PK

A CLI to easily list, search and connect to SSH hosts. Sync down hosts from providers in order to get a centralized hosts configuration.

License: MIT License

Go 100.00%

cli ssh-hosts gitlab fzf github sync hssh

hssh's Introduction

A CLI to easily list, search and connect to SSH hosts. Sync down hosts from providers in order to get a centralized hosts configuration.

Install

Add Homebrew Beliven tap with:

  brew tap beliven-it/tap

Then install hssh CLI with:

  brew install hssh

Configuration

Run hssh init to generate config file inside ~/.config/hssh/config.yml (works only if not exists yet) or let the CLI creating it automatically on first run (every command).

Right now the CLI supports the following providers:

GitLab
GitHub

Providers

Provide at least one connection string to a provider to start using the CLI. You can use more providers at the same time. Replace values as reported below.

PROVIDER is the provider name, like github or gitlab.
ACCESS_TOKEN is the provider access token. Required only for private projects/repositories.
ENTITY_ID is the reference to the project/repository where the files are stored. For GitLab is the project ID, you can find it under the project name (eg. 7192789). For GitHub is the name of the repository (eg. beliven-it/hssh).
SUBPATH is the path to the folder inside the project/repository where config files are saved. This parameter is optional, if you want to store hosts files inside the root of the project/repository, you can delete the @ and everything after it in the connection string.

You can also provide a structured version of the provider configuration in the following format:

providers:
  - type: gitlab
    url: "https://gitlab.com/api/v4"
    access_token: gpat-123456789
    entity_id: 9999
    subpath: "path/to/folder"
  - type: gitlab
    url: "https://git.my-domain.com/api/v4"
    access_token: mydingpat-123444444
    entity_id: 11
    subpath: "path"

NOTE

You cannot have the two providers configuration in different format. Make sure to use or the structured version, or the string version.

fzf options

See the man page (man fzf) for the full list of available options and add the desired ones to the fzf_options string inside ~/.config/hssh/config.yml. See more about the fzf options in the official repository.

Config file example

This is a complete config file example with two providers:

# HSSH configuration file
fzf_options: "-i"
providers:
  - "gitlab://my_access_token:/7192789@folder"
  - "github://my_access_token:/beliven-it/hssh"

Provider project/repository example

Project/repository example structure with subfolder:

  project/repository
  └── folder
      ├── file1
      └── file2

Project/repository example structure without subfolder:

  project/repository
  ├── file1
  └── file2

SSH host example to put inside hosts files:

  Host test
    Hostname 1.2.3.4
    User root
    Port 22
    IdentityFile ~/ssh/id_rsa

Usage

To see available commands and options, run: hssh, hssh help, hssh --help or hssh -h.

Development

Clone the repository and run inside the folder:

go mod init hssh
go mod vendor
go build -ldflags="-X hssh/cmd.Version=1.0.0"

Run ./hssh inside the folder to test the CLI.

Have found a bug?

Please open a new issue here.

Mentions

dmitri13 for the icon of the terminal used in the banner image

License

Licensed under MIT

hssh's People

Contributors

Stargazers

Watchers

Forkers

valentinocossar

hssh's Issues

Integrate unit tests

I've start adding some unit test, More test must be done!!

Host settings in case insensitive

Sometimes it happens that some connections attributes like 'Hostname' are inserted as 'HostName'.
To avoid problems it is better to convert attribute to lowercase.

HostName -> hostname
Hostname -> hostname

Using Host with multiple alias hssh is unable to connect

Hello!,
when my ssh config has multiple aliases in Host declaration, hssh fails to connect,
this is an example:

    Hostname 1.2.3.4
    Port 22
    StrictHostKeyChecking no
    UserKnownHostsFile=/dev/null
    User root
    IdentityFile ~/.ssh/id_rsa

Add fuzzysearch_options inside config file

Add fuzzysearch_options inside config file to allow customization of fzf options to use with hssh.

Add ~/.ssh/config custom hosts to connect and find commands

Add ~/.ssh/config custom hosts to connect and find commands. Allow using custom hosts not added by the sync command but added manually to the ~/.ssh/config file.

Status of connection

Can you make sense to set up a flag to apply a control over the connection status? I have a lot of hosts I don't have access, it would be nice to know what I can connect and to what not, what do you think?

An example could be:

hssh l --status-ok

The functions for each host perform a test connection and print the only available host.

Add example config file in README

Add example config file in README to allow simple copy/paste if someone doesn't want to rely on the config file auto-creation feature.

The comments with space indentation are not removed

In this case:

# HSSH start managed
Include config.hssh.d/*
# HSSH end managed
Host Test
    UseKeychain yes
    AddKeysToAgent yes
    IdentityFile ~/.ssh/id_rsa
    # Enable agent forwarding
    # ForwardAgent yes
    # Forces OpenSSH to use only the key declared in the IdentityFile to connect to the various
    # https://man.openbsd.org/ssh_config.5#IdentitiesOnly
    # IdentitiesOnly yes

Only the first two comments are deleted. This produce a format error during listing as you can see in the screenshot above.

@: # Forces OpenSSH to use only the key declared in the to connect to the various

Add search by IP address

It would be nice If I can be able to search for a host also through its IP.

Fast find using additional argument

Same logic reported in issue #11

Daemon for automatic sync

It may also be useful to set up a command / flag that launches the background application and dealing with the sync of the data remotely.

hssh -d

hsshd

Fast connect using additional argument

Add the ability to connect faster inside a host providing his name instead searching through FZF

Remove wildcard host from fzf hosts list

Remove wildcard host from fzf hosts list. This kind of host is not for a single connection but to set config options for all hosts, so we can fix this by ignoring every host with a wildcard in the name.

Inconsistent parsing results

Sometimes the list of results of the command hssh l are not the same. This problem is related to invalid use of gorutines and channel inside the list controller. Maybe is better to reduce the complexity of this part into a simple one.

Not all commands auto-create the configuration file on the first run

Possible bug to test: not all commands auto-create the configuration file on the first run.

Add multi-provider logic

Add multi-provider logic with support for more than one provider at the same time, this allows to pull hosts from more than one source.

Tip: pay attention to file conflicts inside config.hssh.d folder, prepend config files name with provider.file-name or add a provider sub folder logic.

Ignore connections with empty hostname or not set

Sync twice if running hssh s

If you have the folder config.hssh.d empty, and you run hssh s the sync command run twice, because the system first perform the automatic sync (it occurred when the folder is empty) and then execute the sync command. Maybe the best way to resolve this problem is to disable the automatic sync and notify the user to run the sync command manually

Add support for JumpCloud provider

Using JumpCloud SDK for Go, add JumpCloud provider to get hosts from their APIs.

Add message/warning to run sync when hosts on provider are changed after the last sync

Add message/warning to run sync when hosts on provider are changed after the last sync. With this implementation, we aim to notify users when hosts are changed on the provider repository after they do the last sync, in this way a user knows when he has to run another sync to pull the latest hosts.

Sync is inconsistent

It seems that running the sync command using goroutines sometimes cause the random elimination of some host files.
Maybe is better slow it down but more consistent.

Add dependabot.yml

Add dependabot.yml to keep project dependencies up to date.

Delete old synced folder before a new sync

Because a folder could have old files inside, an improvement could be deleting synced folder before redownloading it. This fixes a current issue with the new multi-provider function and the new file naming convention (eg. test.gitlab) that causes duplicated files: the older ones (pre multi-provider) and the new ones (post multi-provider) that are equal.