remix-project mirror
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
yann300 fb93b1511c Merge pull request #106 from ethereum/bumpVersion.16 5 years ago
.circleci Added circleci config and eslint 5 years ago
bin Merge pull request #70 from Alonski/patch-1 5 years ago
src Return callback with error on fail 5 years ago
.eslintrc.json Added circleci config and eslint 5 years ago
.gitignore vyper compiler 6 years ago
README.md remove deprecated options 5 years ago
package-lock.json bump version 5 years ago
package.json bump version 5 years ago

README.md

Remixd

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 make 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

INSTALLATION

npm install -g remixd

HELP SECTION

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

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

  Options:

  --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

SHARE A FOLDER

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.