# vfs

> Experimental SFTP over WebSockets filesystem client running on top of SSHFS

Latest version **0.2.2** (published 2015-11-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install vfs
pnpm add vfs
yarn add vfs
bun add vfs
```

Provides the command `vfs`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.2 |
| Published | 2015-11-28 |
| First published | 2015-11-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Lukas Pokorny |
| Maintainers | lukaaash |
| Keywords | SFTP, filesystem, FUSE |

## Links

- npm: https://www.npmjs.com/package/vfs
- Repository: https://github.com/lukaaash/vfs
- Homepage: https://github.com/lukaaash/vfs#readme
- Issues: https://github.com/lukaaash/vfs/issues
- npm.io page: https://npm.io/package/vfs

## Dependencies (2)

- [minish](https://npm.io/package/minish.md) ^0.5.4
- [sftp-ws](https://npm.io/package/sftp-ws.md) ~0.7.0

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 0.2.2 (latest) — 2015-11-28
- 0.2.1 — 2015-11-26
- 0.2.0 — 2015-11-23

## README

vfs
===

VFS is an experimental wrapper around [SSHFS](http://fuse.sourceforge.net/sshfs.html) written in Node.js.
It makes it possible to mount remote filesystems accessible through [SFTP over WebSockets](http://sftp.ws/)
(instead of common SFTP over SSH).

In future, it might support other kinds of virtual filesystems as well.

**Note:** At the client side, Linux with `sshfs` and Node.js is required.

## Getting started

1. Setup an [SFTP over WebSockets server](https://www.npmjs.com/package/sftp-ws/) at the remote machine (or skip this step and try `wss://nuane.com/sftp`).
2. Install `sshfs` at the client (in Debian/Ubuntu, run `apt-get install sshfs` as root).
3. Install `vfs` at the client by running `npm install vfs` (add `-g` as root to install globally).
4. Mount a remote filesystem to a local directory by running `vfs url mountpoint` (for example `vfs wss://nuane.com/sftp ~/sftp`). Optionally, add `--path=path_name` to specify a remote path if you only wish to mount a part of the remote filesystem.
5. Enjoy the remote filesystem! :-)

## Missing features

- Add the ability to easily start the filesystem client in the background.
- Make it possible to pass SSHFS and FUSE options from command line.
- More authentication options (only `Basic` authentication is supported at the moment, which is insufficient).

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