1 | # Remixd
|
2 |
|
3 | `remixd` is a tool that intend to be used with [Remix IDE](http://github.com/ethereum/browser-solidity) (aka. Browser-Solidity). It allows a websocket connection between
|
4 | `Remix IDE` (web application) and the local computer.
|
5 |
|
6 | Practically Remix IDE make available a folder shared by `remixd`.
|
7 |
|
8 | More details are explained in this [tutorial](http://remix.readthedocs.io/en/latest/tutorial_remixd_filesystem.html).
|
9 |
|
10 | Alternatively `remixd` can be used to setup a development environment that can be used with other popular frameworks like Embark, Truffle, Ganache, etc..
|
11 |
|
12 | `remixd` needs `npm` and `node`
|
13 |
|
14 | ## INSTALLATION
|
15 |
|
16 | `npm install -g remixd`
|
17 |
|
18 | ## HELP SECTION
|
19 |
|
20 | ```
|
21 | Usage: remixd -s <shared folder> --remix-ide https://remix.ethereum.org
|
22 |
|
23 | Provide a two-way connection between the local computer and Remix IDE.
|
24 |
|
25 |
|
26 | Options:
|
27 |
|
28 | --remix-ide <url> URL of remix instance allowed to connect to this
|
29 | web sockect connection
|
30 | -s, --shared-folder <path> Folder to share with Remix IDE
|
31 | --read-only Treat shared folder as read-only (experimental)
|
32 | -h, --help output usage information
|
33 |
|
34 | ```
|
35 |
|
36 | ## SHARE A FOLDER
|
37 |
|
38 | `remixd -s <absolute-path> --remix-ide https://remix.ethereum.org`
|
39 |
|
40 | The current user should have `read/write` access to the folder (at least `read` access).
|
41 |
|
42 | 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.
|
43 |
|
44 | Furthermore :
|
45 | - No copy of the shared folder are kept in the browser storage.
|
46 | - It is not possible to create a file from `Remix IDE` (that might change).
|
47 | - If a folder does not contain any file, the folder will not be displayed in the explorer (that might change).
|
48 | - Symbolic links are not forwarded to Remix IDE.
|
49 | |
\ | No newline at end of file |