https://github.com/ethereum/remixd

remix server
https://github.com/ethereum/remixd

Last synced: 5 months ago
JSON representation

remix server

• Host: GitHub
• URL: https://github.com/ethereum/remixd
• Owner: ethereum
• Archived: true
• Created: 2017-05-29T16:46:40.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2021-03-03T15:20:33.000Z (over 4 years ago)
• Last Synced: 2024-09-17T22:32:34.327Z (9 months ago)
• Language: TypeScript
• Homepage:
• Size: 558 KB
• Stars: 181
• Watchers: 20
• Forks: 106
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
**The project code base has been moved to [remix-project/remixd](https://github.com/ethereum/remix-project/tree/master/libs/remixd).**

`remixd` is a tool that intend to be used with [Remix IDE](http://github.com/ethereum/remix-project) (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](https://remix-ide.readthedocs.io/en/latest/remixd.html).

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  --remix-ide https://remix.ethereum.org

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

  

  Options:

  --remix-ide                      URL of remix instance allowed to connect to this 

                                        web sockect connection

  -s, --shared-folder             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  --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.