File sync

3 min read

Learn how to sync files between Coder and your local IDE.

If you're working in an IDE that's on your local machine, you can use Coder's live sync feature to sync changes from your local IDE with your Coder workspace. Live sync watches your IDE and pushes updates whenever it detects changes. This allows you to work locally while leveraging Coder for testing, compilation, and so on.

One-way file sync

  1. Make sure that you've installed rsync on both your local machine and Coder workspace.

  2. To establish a one-way directory sync to a remote workspace:

    coder sync [local directory] [<env name>:<remote directory>]

    Include the -i or --init flag for initial transfer and exit.


To sync your local directory ~/Projects/cdr/coder-cli to coder-cli in the home directory of your workspace:

$ coder sync ~/Projects/cdr/coder-cli my-env:coder-cli
2020-05-19 17:57:40 INFO doing initial sync (~/Projects/cdr/coder-cli -> coder-cli)
2020-05-19 17:57:41 SUCCESS finished initial sync (878ms)
2020-05-19 17:57:41 INFO watching ~/Projects/cdr/coder-cli for changes

Two-way file sync

Alternatively, you can set up two-way file sync, which allows you to simultaneously use local and remote development tools. Setting up two-way file sync can help ensure your project is in the same state no matter where you make changes.

  1. Make sure that you've installed Mutagen.

  2. Log into Coder and configure your local SSH client:

    $ coder login
    2020-10-20 11:16:29 SUCCESS Logged in.
    $ coder config-ssh
    An auto-generated ssh config was written to "/Users/yourName/.ssh/config"
    Your private ssh key was written to "/Users/yourName/.ssh/coder_enterprise"
    You should now be able to ssh into your workspace
    For example, try running
        $ ssh coder.yourName
  3. Identify your project directory and workspace name, then create the sync session. Note that the folder must exist on the remote server before you begin this step:

    $ cd ~/my-project
    $ coder envs ls
    Name     ImageTag    CPUCores    MemoryGB    DiskGB    GPUs    Updating    Status
    yourName latest      4           4           30        0       false       ON
    test     latest      1           1           10        0       false       OFF
    $ mutagen sync create . coder.env-name:~/project
    Created session sync_dLg9zfqynqVa9aj2V36Fr4OCMz1AHzTKzNGFYYkqfAI
  4. Test your connection by running mutagen sync monitor. If you're successful, your project files should sync on all future changes.

Pausing or terminating your session

You can pause your sync by running mutagen sync pause.

You can stop and delete your session by running mutagen sync terminate.

Our docs are open source. See something wrong or unclear? Make an edit.