masasam / emacs-counsel-tramp

Tramp ivy interface for ssh and docker and ‎vagrant

counsel-tramp

Tramp ivy interface for ssh server and docker and vagrant

Screencast

M-x counsel-tramp

Display server list from your ~/.ssh/config with counsel interface.

Filter by counsel.

You can connect your server with tramp.

Selecting the list with sudo will lead to the server as root.

Selecting the list of '/sudo:root@localhost:/' will open file at localhost as root.

You can edit your server's nginx.conf on your emacs!

If you are using docker-tramp, docker is also supplemented. If you are using vagrant-tramp, vagrant is also supplemented.

You can edit docker container on your emacs!

counsel-tramp-quit

When you finish editing nginx.conf you clean the tramp buffer with counsel-tramp-quit command.

Requirements

• Emacs 24.3 or higher
• counsel 0.10.0 or higher

Installation

You can install counsel-tramp.el from MELPA with package.el (M-x package-install counsel-tramp).
You can install docker-tramp.el from MELPA with package.el (M-x package-install docker-tramp).
If you use Emacs version >= 29.0.60 then docker-tramp is no longer necessary as this functionality is built-in to Tramp.
You can install vagrant-tramp.el from MELPA with package.el (M-x package-install vagrant-tramp).

I recommend you are going to install exec-path-from-shell.

Sample Configuration

(setq tramp-default-method "ssh")
(define-key global-map (kbd "C-c s") 'counsel-tramp)

If you want to speed up tramp

(add-hook 'counsel-tramp-pre-command-hook '(lambda () (global-aggressive-indent-mode 0)
				     (projectile-mode 0)
				     (editorconfig-mode 0)))
(add-hook 'counsel-tramp-quit-hook '(lambda () (global-aggressive-indent-mode 1)
			      (projectile-mode 1)
			      (editorconfig-mode 1)))

Setting hook that turn off slow extensions when you execute counsel-tramp. Setting hook that turn on extensions when you execute counsel-tramp-quit command.

If you don't make a backup files and lockfiles at remote server, it will be saved faster.

(setq make-backup-files nil)
(setq create-lockfiles nil)

Misc setting

Besides ~/.ssh/config, you can add connections manually.

(setq counsel-tramp-custom-connections '(/ssh:domain|sudo:user@localhost:/))

Example when adding more than two connections manually.

(setq counsel-tramp-custom-connections '(/ssh:domain|sudo:user@localhost:/ /ssh:domain2|sudo:user@localhost:/))

If the shell of the server is zsh it is recommended to connect with bash.

(eval-after-load 'tramp '(setenv "SHELL" "/bin/bash"))

If you want to specify the user name to connect with docker-tramp.

(setq counsel-tramp-docker-user "username")

If you want to specify multiple user name list to connect with docker-tramp.

(setq counsel-tramp-docker-user '("username1" "username2" "username3" "username4"))

If you want to change initial directory when connecting with /sudo:root@localhost:.

(setq counsel-tramp-localhost-directory "/var")

Support for top-level sshconfig include

In addition to normal .ssh/config, it also supports the following format.

~/.ssh/config

Include conf.d/work
Include conf.d/personal

~/.ssh/conf.d/work

Host instance
	HostName ************
	User ************

Host archtest
	HostName ************
	User ************

Host debiantest
	HostName ************
	User ************

Host centostest
	HostName ************
	User ************

~/.ssh/conf.d/personal

Host myserver
	HostName ************
	User ************

Host myhost
	HostName ************
	User ************

Below is not support

~/.ssh/config

Include conf.d/**

Support controlmaster paths

You can use it as follows.

(setq helm-tramp-control-master t)

Set ~/.ssh/config as below

Host *
  ControlMaster auto
  ControlPath ~/.ssh/master-%r@%h:%p
  ControlPersist 30m
  ServerAliveInterval 60

Execute the ssh command as follows

ssh [email protected]

~/.ssh/[email protected] will be generated automatically. Even if there is no connection setting in ~/.ssh/config, counsel-tramp can complement like bellow.

/ssh:[email protected]:
/ssh:[email protected]|sudo:[email protected]:/

emacs-counsel-tramp's Issues

Make `docker` optional

I do not use docker often, but I do use ssh extensively. However, the counsel-tramp package throws an error if docker is not installed. Can we avoid the hard dependency on docker even for newer versions of Emacs?

Provide default directory to open on remote

I ssh to different remote machines, and the work directory is sometimes different from the home directory that tramp logs in to. Is it possible to make counsel-tramp open a custom default directory when I login to a machine A?

For example, default directory on Machine A is /users/swarnendu and default directory on Machine B is /data/swarnendu.

Can't find recent remote file by counsel recentf

Hi,

Thanks for your great work on this.

But I can't use counsel recentf to find the recently opened remote files as shown in your screenshot. How do you setup this?

Use known hosts instead of config

My ssh config has lots of wildcard patterns for hosts under domain names. Basically, my ssh config is useless for getting host names. Specific host names would probably be easier to get out of known hosts.

Cannot connect - docker not installed

Hello, thanks for a great plugin.

I have followed the install instructions and tried all possible settings but when I run M-x counsel-tramp I get "counsel-tramp: ’docker’ is not installed" in Emacs 25.3. Any ideas, perhaps its a setting in Docker I missing... but Docker works

Allow connecting with a different username

I have connections set up in .ssh/config that have a different user name provided through User. However, counsel-tramp seems to always pick up my current login name, which is problematic. Can this be fixed?

FYI, this works fine with regular tramp over ivy/counsel.