remix server: allow accessing file system from remix.ethereum.org and start a dev environment (see help section)
Last updated 2 months ago by aniket-engg .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @remix-project/remixd 
SYNC missed versions from official npm registry.


remixd is a tool that intend to be used with Remix IDE (aka. Browser-Solidity). It allows a websocket connection between Remix IDE (web application) and the local computer.

Practically Remix IDE makes available a folder shared by remixd.

More details are explained in this tutorial.

Alternatively remixd can be used to setup a development environment that can be used with other popular frameworks like Embark, Truffle, Ganache, etc..

remixd needs npm and node


npm install -g @remix-project/remixd


  Usage: remixd -s <shared folder> --remix-ide https://remix.ethereum.org

  Provide a two-way connection between the local computer and Remix IDE.


  --remix-ide  <url>                    URL of remix instance allowed to connect to this 
                                        web sockect connection
  -s, --shared-folder <path>            Folder to share with Remix IDE
  --read-only                           Treat shared folder as read-only (experimental)
  -h, --help                            output usage information


remixd -s <absolute-path> --remix-ide https://remix.ethereum.org

The current user should have read/write access to the folder (at least read access).

It is important to notice that changes made to the current file in Remix IDE are automatically saved to the local computer every 5000 ms. There is no Save action. But the Ctrl-Z (undo) can be used.

Furthermore :

  • No copy of the shared folder are kept in the browser storage.
  • It is not possible to create a file from Remix IDE (that might change).
  • If a folder does not contain any file, the folder will not be displayed in the explorer (that might change).
  • Symbolic links are not forwarded to Remix IDE.

Current Tags

  • 0.2.4-alpha.1                                ...           latest (2 months ago)

1 Versions

  • 0.2.4-alpha.1                                ...           2 months ago
Maintainers (2)
Today 0
This Week 0
This Month 1
Last Day 0
Last Week 0
Last Month 0
Dependencies (10)
Dependents (0)

Copyright 2014 - 2017 © taobao.org |