# kappa-drive-mount

> Mount a kappa-drive with hyperdrive-fuse

Latest version **1.2.0** (published 2020-07-29) · AGPL-3.0-only license · 0 weekly downloads

## Install

```sh
npm install kappa-drive-mount
pnpm add kappa-drive-mount
yarn add kappa-drive-mount
bun add kappa-drive-mount
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2020-07-29 |
| First published | 2019-09-16 |
| Weekly downloads | 0 |
| License | AGPL-3.0-only |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 63.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Magma Collective |
| Maintainers | ameba23, kyphae |
| Keywords | cobox, fuse, mount, peer-fs, kappa-drive, hyperdrive, dat, kappa-core, multiwriter |

## Links

- npm: https://www.npmjs.com/package/kappa-drive-mount
- Repository: http://ledger-git.dyne.org:3000/CoBox/kappa-drive-mount
- Homepage: https://ledger-git.dyne.org/CoBox/kappa-drive-mount
- Issues: https://ledger-git.dyne.org/CoBox/kappa-drive-mount/issues
- npm.io page: https://npm.io/package/kappa-drive-mount

## Dependencies (5)

- [debug](https://npm.io/package/debug.md) ^4.1.1
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1
- [rimraf](https://npm.io/package/rimraf.md) ^2.6.3
- [call-me-maybe](https://npm.io/package/call-me-maybe.md) ^1.0.1
- [hyperdrive-fuse](https://npm.io/package/hyperdrive-fuse.md) 1.2.1

## Alternatives

- [vest](https://npm.io/package/vest.md) — 50.1K weekly downloads
- [@regle/core](https://npm.io/package/@regle/core.md) — 47.0K weekly downloads
- [typeof-arguments](https://npm.io/package/typeof-arguments.md) — 12.5K weekly downloads
- [@lokalise/projects-engine-contracts](https://npm.io/package/@lokalise/projects-engine-contracts.md) — 978 weekly downloads
- [@osjwnpm/nam-laboriosam-quibusdam](https://npm.io/package/@osjwnpm/nam-laboriosam-quibusdam.md) — 70 weekly downloads

## Recent versions

- 1.2.0 (latest) — 2020-07-29
- 1.0.6 — 2020-01-22
- 1.0.5 — 2020-01-04
- 1.0.4 — 2020-01-02
- 1.0.3 — 2019-12-13
- 1.0.2 — 2019-12-11
- 1.0.1 — 2019-11-15
- 1.1.0 — 2019-09-16

## README

# kappa-drive-mount

<div align="center">
  <img src="https://cobox.cloud/src/svg/logo.svg">
</div>

[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)

## Table of Contents

- [About](#about)
- [Install](#install)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)

## About
**CoBox** is an encrypted p2p file system and distributed back-up tool. [README](https://gitlab.com/coboxcoop/readme) provides a map of the project.

`kappa-drive-mount` enables you to mount a `kappa-drive` with [`hyperdrive-fuse`](https://github.com/andrewosh/hyperdrive-fuse/).

## Install

TODO

## Usage

This will mount a kappa-drive for 3 seconds, and then unmount it.

```js
const KappaDrive = require('kappa-drive')
const mount = require('./')

const mountdir = './mnt'
const storage = './drive'
const drive = KappaDrive(storage)

mount(drive, mountdir, (err, unmount) => {
  if (err) return console.error(err)

  setTimeout(() => {
    unmount()
  }, 3000)
})
```

## API
```js
const mount = require('kappa-drive-mount')
mount(drive, destination, [options,] callback)
```

mount a kappa-drive, `drive` at path `destination`. `options`, if given, will be passed to `hyperdrive-fuse`.

`callback` will be given arguments `(err, unmount)`.  `unmount` is a function which can be used to unmount the drive.  The drive can also be unmounted by sending the `'SIGINT'` event (pressing Ctrl + C).


## Contributing

PRs accepted.

Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.

## License

TODO

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