remix-project/docs/tutorial_remixd_filesystem.rst

Accessing a shared folder in Remix IDE using Remixd
===================================================

.. _tutorial-remixd-filesystem:

Remixd is an npm module. Its purpose is to give the remix web application access to a folder from your local computer.

The code of Remixd can be checked out `here <https://github.com/ethereum/remixd>`_ .

Remixd can be globally installed using the following command: ``npm install -g remixd``.

Then ``remixd -S <absolute-path-to-the-shared-folder>`` will start Remixd and share the given folder.

The folder is shared using a websocket connection between ``Remix IDE`` and ``Remixd``.

Be sure the user executing Remix has read/write permission on the folder.

.. warning::
  Remixd provides full read and write access to the given folder for any application that can access the TCP port 65520 on your local host.

From ``Remix IDE``, you will need to activate the connection.

Click on the ``localhost connection`` icon:

.. image:: remixd_noconnection.png

A modal dialog will ask confirmation

.. image:: remixd_alert.png

Accepting this dialog will start a session. Once the connection is made, the status will update and the connection icon should shows up in green.

Hovering the icon will give more connection status information.

At this point if the connection is successful, the shared folder will be available in the file explorer.

.. image:: remixd_connectionok.png