mirror of
https://github.com/hashicorp/vagrant.git
synced 2026-02-03 20:39:27 -05:00
55 lines
2.1 KiB
Text
55 lines
2.1 KiB
Text
---
|
|
layout: docs
|
|
page_title: vagrant rsync-auto - Command-Line Interface
|
|
description: |-
|
|
The "vagrant rsync-auto" command watches all local directories of any rsync
|
|
configured synced folders and automatically initiates an rsync transfer when
|
|
changes are detected.
|
|
---
|
|
|
|
# rsync-auto
|
|
|
|
**Command: `vagrant rsync-auto`**
|
|
|
|
This command watches all local directories of any
|
|
[rsync synced folders](/vagrant/docs/synced-folders/rsync) and automatically
|
|
initiates an rsync transfer when changes are detected. This command does
|
|
not exit until an interrupt is received.
|
|
|
|
The change detection is optimized to use platform-specific APIs to listen
|
|
for filesystem changes, and does not simply poll the directory.
|
|
|
|
## Options
|
|
|
|
- `--[no-]rsync-chown` - Use rsync to modify ownership of transferred files. Enabling
|
|
this option can result in faster completion due to a secondary process not being
|
|
required to update ownership. By default this is disabled.
|
|
|
|
- `--[no-]poll` - Force Vagrant to watch for changes using filesystem
|
|
polling instead of filesystem events. This is required for some filesystems
|
|
that do not support events. Warning: enabling this will make `rsync-auto`
|
|
_much_ slower. By default, polling is disabled.
|
|
|
|
## Machine State Changes
|
|
|
|
The `rsync-auto` command does not currently handle machine state changes
|
|
gracefully. For example, if you start the `rsync-auto` command, then
|
|
halt the guest machine, then make changes to some files, then boot it
|
|
back up, `rsync-auto` will not attempt to resync.
|
|
|
|
To ensure that the command works properly, you should start `rsync-auto`
|
|
only when the machine is running, and shut it down before any machine
|
|
state changes.
|
|
|
|
You can always force a resync with the [rsync](/vagrant/docs/cli/rsync) command.
|
|
|
|
## Vagrantfile Changes
|
|
|
|
If you change or move your Vagrantfile, the `rsync-auto` command will have
|
|
to be restarted. For example, if you add synced folders to the Vagrantfile,
|
|
or move the directory that contains the Vagrantfile, the `rsync-auto`
|
|
command will either not pick up the changes or may begin experiencing
|
|
strange behavior.
|
|
|
|
Before making any such changes, it is recommended that you turn off
|
|
`rsync-auto`, then restart it afterwards.
|