aronatkins/vagrant-tramp

Vagrant method for Emacs' tramp

#Vagrant TRAMP

Synopsis

vagrant-tramp adds an Emacs TRAMP method for Vagrant boxes. As far as TRAMP is concerned, the vagrant method behaves just as the built-in ssh method does. The vagrant method simply provides auto-completion for Vagrant boxes and a wrapper around vagrant ssh for connecting to boxes.

Installation

If you have a recent Emacs with package.el, you can install vagrant-tramp from MELPA.

Or via el-get

Or manually add to your emacs load-path.

Configuration

(eval-after-load 'tramp
  '(vagrant-tramp-enable))

Usage

The TRAMP method vagrant runs the vagrant-tramp-ssh script to get a list of running Vagrant boxes used in the auto-complete function:

C-x C-f /vagrant:

Find file: /vagrant:
-> devbox:
   esxbox:
   kafka-broker1:
   kafka-broker2:
   kafka-zookeeper:

Boxes are named using the Vagrantfile directory basename and the VM name (excluding default) to support multi-VM environments. When TRAMP opens a connection via vagrant-tramp-ssh, the script just cd's into the Vagrantfile directory and execs vagrant ssh $box_name.

Opening a file as root

Use this trick from the Emacs Wiki, where we replaced "ssh" with "vagrant" and where "box" is a Vagrant box name:

C-x C-f /vagrant:box|sudo:box:/path/to/file RET

vagrant-tramp-term

The vagrant-tramp-term function uses vagrant-tramp-ssh to provide a list of completions, selection upon which will vagrant ssh to the given box using an ansi-term.

M-x vagrant-tramp-term

vagrant ssh to box:
-> devbox:
   kafka-broker1:
   kafka-broker2:

Supported Vagrant providers

The vagrant-tramp-ssh script works with the following Vagrant providers:

• VMware Fusion

• VMware Workstation

• VirtualBox

See also

• vagrant-el