Can I rename a Vagrant box?

Question

I misspelled the name of a box when I added it to my box list:

vagrant box list
debian
ubnutu

Can I rename the box without repackaging it?

score 48 · Answer 1 · answered Nov 09 '11 at 13:25

48

You can simply rename the dir that represents the box. If your vagrant files are in their default dir (i.e. /path/to/your/home/.vagrant.d) you can just do:

mv vagrant_path/boxes/box_to_rename vagrant_path/boxes/new_box_name

Also be sure to change the Vagrantfile to use the new label for the box. You just need to change the config.vm.box directive to reflect the changes.

answered Nov 09 '11 at 13:25

Tiago

581
3
3

This didn't work for me - I suspect there is a config file somewhere that needs to be updated as well. @Till's suggestion worked. – Adrian Mouat Feb 11 '14 at 11:35
@AdrianMouat: Hmm, worked for me. Did you have VMs actively running with the box in question at the time of the rename? I could imagine that maybe causing problems, though I don't really know that or why it would, necessarily. What results did you get when you tried? – lindes-hw Nov 16 '14 at 06:36
@lindes-hw I've no idea, it was 10 months ago... – Adrian Mouat Nov 17 '14 at 09:13
@AdrianMouat: fair enough. Mostly, I just wanted to not have that comment left there un-responded-to, as it detracts (to my mind) from the idea of this being a correct answer, and yet, I think it is. If there are real problems with it, though, it would be good to hear about them - whether from you, or someone else who encounters them in the future. – lindes-hw Nov 17 '14 at 18:31
@lindes-hw It might be relevant that I was running on Mac OS. I don't believe I had actively running VMs at the time; I think I would have checked that. – Adrian Mouat Nov 18 '14 at 19:11
OK, well my test just now was also on MacOS. So I don't know... – lindes-hw Nov 19 '14 at 19:41
On Linux, the box would typically be in ~/.vagrant.d/boxes. So you can do `mv ~/.vagrant.d/boxes/ ~/.vagrant.d/boxes/` EDIT: Sorry, didn't catch the note in the parenthesis, I will leave the duplicate here anyway, since it is visually clearer for me and maybe others as well. – AdamKalisz Mar 20 '20 at 16:10

score 13 · Answer 2 · edited Mar 21 '17 at 06:29

13

I would do this:

$ vagrant box repackage misspelled-name
[vagrant] Compressing package to: /Users/johndoe/package.box
$ vagrant box add correct-name /Users/johndoe/package.box
...

Not the worst to know about these two anyway, since you can frequently update base boxes (e.g. to update the kernel, software and guest additions) to avoid running all these required updates every time you vagrant up.

edited Mar 21 '17 at 06:29

cjs

918
1
6
13

answered Sep 17 '12 at 14:27

Till

397
3
9

Is it okay to delete the package.box file when this is done? – Peter Hanley Oct 08 '12 at 00:33
1

@PeterHanley Yep. Once imported, it's ok to get rid off it. – Till Oct 08 '12 at 16:35
2

Note that this will take much longer than simply renaming the underlying file, and does lots of extra work that's probably not necessary in most (all?) cases. – lindes-hw Nov 16 '14 at 06:37
@lindes-hw can you show a better way? And why? – Felipe Alvarez Feb 23 '16 at 06:15

score 0 · Answer 3 · answered Feb 17 '20 at 09:01

0

On windows, you can rename the box folder name here. C:\Users\uday.vagrant.d\boxes\

It will update automatically

answered Feb 17 '20 at 09:01

user2331760

1
5

Can I rename a Vagrant box?

3 Answers3