# @remix-project/remixd

> remix server: allow accessing file system from remix.ethereum.org and start a dev environment (see help section)

Latest version **0.6.65** (published 2026-06-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install @remix-project/remixd
pnpm add @remix-project/remixd
yarn add @remix-project/remixd
bun add @remix-project/remixd
```

Provides the command `remixd`.

## Health

**Score 55/100 (C)** — status: active.

Positive: has types; no vulnerabilities; high maintenance score.

Warnings: low downloads; no esm support; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.6.65 |
| Published | 2026-06-06 |
| First published | 2020-11-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 14 |
| Unpacked size | 143.9 KB |
| Known vulnerabilities | 0 (+28 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3052 |
| Author | Remix Team |
| Maintainers | ryestew, yann300, aniket-engg, ioedeveloper, yann_remixlabs |
| Keywords | remix, ide, ethereum, solidity |

## Links

- npm: https://www.npmjs.com/package/@remix-project/remixd
- Repository: https://github.com/remix-project-org/remix-project
- Homepage: https://github.com/remix-project-org/remix-project#readme
- Issues: https://github.com/remix-project-org/remix-project/issues
- npm.io page: https://npm.io/package/@remix-project/remixd

## Dependencies (14)

- [ws](https://npm.io/package/ws.md) ^7.3.0
- [axios](https://npm.io/package/axios.md) 1.12.0
- [bn.js](https://npm.io/package/bn.js.md) ^5.1.2
- [semver](https://npm.io/package/semver.md) ^6.3.0
- [chokidar](https://npm.io/package/chokidar.md) ^2.1.8
- [fs-extra](https://npm.io/package/fs-extra.md) ^3.0.1
- [commander](https://npm.io/package/commander.md) ^9.4.1
- [isbinaryfile](https://npm.io/package/isbinaryfile.md) ^3.0.2
- [latest-version](https://npm.io/package/latest-version.md) ^5.1.0
- [@remixproject/plugin](https://npm.io/package/@remixproject/plugin.md) 0.3.33
- [@remixproject/plugin-ws](https://npm.io/package/@remixproject/plugin-ws.md) 0.3.33
- [@remixproject/plugin-api](https://npm.io/package/@remixproject/plugin-api.md) 0.3.33
- [@remixproject/plugin-utils](https://npm.io/package/@remixproject/plugin-utils.md) 0.3.33
- [@remix-project/remix-solidity](https://npm.io/package/@remix-project/remix-solidity.md) ^0.5.36

## Alternatives

- [adhdev](https://npm.io/package/adhdev.md) — 11.1K weekly downloads
- [react-slide-button](https://npm.io/package/react-slide-button.md) — 310 weekly downloads
- [better](https://npm.io/package/better.md) — 42 weekly downloads
- [react-native-swipe-image](https://npm.io/package/react-native-swipe-image.md) — 22 weekly downloads
- [nl.fokkezb.pulltorefresh](https://npm.io/package/nl.fokkezb.pulltorefresh.md) — 11 weekly downloads

## Recent versions

- 0.6.65 (latest) — 2026-06-06
- 0.3.6-beta (beta) — 2021-02-04
- 0.3.1-alpha.1 (dev) — 2021-02-04
- 0.6.64 — 2026-04-27
- 0.6.63 — 2026-04-15
- 0.6.62 — 2026-04-09
- 0.6.61 — 2026-03-25
- 0.6.60 — 2025-12-24
- 0.6.59 — 2025-12-10
- 0.6.58 — 2025-12-03
- 0.6.57 — 2025-11-18
- 0.6.56 — 2025-10-16
- 0.6.55 — 2025-09-23
- 0.6.54 — 2025-09-09
- 0.6.53 — 2025-08-28
- … 76 more at https://npm.io/package/@remix-project/remixd/versions

## README

# Remixd

[![npm version](https://badge.fury.io/js/%40remix-project%2Fremixd.svg)](https://www.npmjs.com/package/@remix-project/remixd)
[![npm](https://img.shields.io/npm/dt/@remix-project/remixd.svg?label=Total%20Downloads&logo=npm)](https://www.npmjs.com/package/@remix-project/remixd)
[![npm](https://img.shields.io/npm/dw/@remix-project/remixd.svg?logo=npm)](https://www.npmjs.com/package/@remix-project/remixd)


`@remix-project/remixd` is an NPM module that intends to be used with [Remix IDE](https://remix.ethereum.org/) web and desktop applications. It establishes a two-way websocket connection between the local computer and Remix IDE for a particular project directory.

`remixd` can be used to set up a development environment with other popular frameworks like Hardhat, Truffle, Slither etc.

More details are explained in the [documentation](https://remix-ide.readthedocs.io/en/latest/remixd.html).

## Installation

`npm install -g @remix-project/remixd`

NOTE: When the remixd NPM module is installed, it also installs [Slither](https://github.com/crytic/slither), [solc-select](https://github.com/crytic/solc-select#quickstart) and sets [solc](https://docs.soliditylang.org/en/latest/installing-solidity.html) to latest version i.e. 0.8.15 currently.

ALSO NOTE: Python3.6+ (pip3) needs to already be installed on the System. In case of any discrepancy, Slither can also be installed along with other dependencies using the command:
```
> remixd -i slither
``` 

_(This packaging of Slither with the remixd module is supported since Remixd v0.6.3)_

### Warning for quite old users
There is a new version of remixd with a new npm address: https://npmjs.com/package/@remix-project/remixd
If you were using the old one you need to:

  1. uninstall the old one: `npm uninstall -g remixd`
  2. install the new: `npm install -g @remix-project/remixd`

## remixd command

The remixd command without options shares present working directory and the shared Remix domain will be https://remix.ethereum.org, https://alpha.remix.live, or https://beta.remix.live

The remixd command is:
```
> remixd
```

If you are using Remix from localhost or you are not running the command from your working directory, you’ll need to use the command with flags.

```
> remixd -h
Usage: remixd [options]

Establish a two-way websocket connection between the local computer and Remix IDE for a folder

Options:
  -v, --version               output the version number
  -u, --remix-ide  <url>      URL of remix instance allowed to connect
  -s, --shared-folder <path>  Folder to share with Remix IDE (Default: CWD)
  -i, --install <name>        Module name to install locally (Supported: ["slither"])
  -r, --read-only             Treat shared folder as read-only (experimental)
  -h, --help                  output usage information

Example:

    remixd -s ./shared_project -u http://localhost:8080

```

## Share a project directory

`remixd -s ./shared_project -u 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 is kept in the browser storage.
 - Clicking on the new folder or new file icon under localhost will create a new file or folder in the shared folder.
 - 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.

## Ports Usage
remixd creates a websocket connection with Remix IDE on different ports. Ports are defined according to specific purposes. Port usage details are as:

- **65520** : For `remixd` websocket listener, to share a project from local device with Remix IDE. Shared folder will be loaded in the Remix IDE File Explorer workspace named localhost [See more](https://remix-ide.readthedocs.io/en/latest/remixd.html)
- **65522** : For `Hardhat` websocket listener, to enable the Hardhat Compilation using Remix IDE Solidity Compiler plugin, if shared folder is a Hardhat project [See more](https://remix-ide.readthedocs.io/en/latest/hardhat.html)
- **65523** : For `Slither` websocket listener, to enable the Slither Analysis using Remix IDE Solidity Static Analysis plugin [See more](https://remix-ide.readthedocs.io/en/latest/slither.html)
- **65524** : For `Truffle` websocket listener, to enable the Truffle Compilation using Remix IDE Solidity Compiler plugin, if shared folder is a Truffle project [See more](https://remix-ide.readthedocs.io/en/latest/truffle.html)

Note: Please make sure your system is secured enough and these ports are not opened nor forwarded.

---
_Source: https://npm.io/package/@remix-project/remixd · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
