# test1dweb

> A CLI for the test1dweb:// space network.

Latest version **1.5.6** (published 2021-03-25) · MIT license · 0 weekly downloads

## Install

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

Provides the command `test1dweb`.

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.5.6 |
| Published | 2021-03-25 |
| First published | 2021-03-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Node | >=14.0.0 |
| Dependencies | 32 |
| Unpacked size | 101.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Blue Link Labs |
| Maintainers | dwebprotocol |
| Keywords | beaker, cli |

## Links

- npm: https://www.npmjs.com/package/test1dweb
- Repository: https://github.com/hypercore-protocol/hypercore-cli
- Homepage: https://github.com/hypercore-protocol/hypercore-cli#readme
- Issues: https://github.com/hypercore-protocol/hypercore-cli/issues
- npm.io page: https://npm.io/package/test1dweb

## Dependencies (32)

- [vm2](https://npm.io/package/vm2.md) ^3.9.2
- [mime](https://npm.io/package/mime.md) ^1.4.0
- [pump](https://npm.io/package/pump.md) ^3.0.0
- [bytes](https://npm.io/package/bytes.md) ^3.1.0
- [chalk](https://npm.io/package/chalk.md) ^1.1.3
- [dcast](https://npm.io/package/dcast.md) ^1.0.0
- [yesno](https://npm.io/package/yesno.md) ^0.3.1
- [ddrive](https://npm.io/package/ddrive.md) ^5.0.0
- [mkdirp](https://npm.io/package/mkdirp.md) ^1.0.4
- [moment](https://npm.io/package/moment.md) ^2.17.0
- [chokidar](https://npm.io/package/chokidar.md) ^3.4.3
- [dwebtree](https://npm.io/package/dwebtree.md) ^1.0.0
- [through2](https://npm.io/package/through2.md) ^4.0.2
- [username](https://npm.io/package/username.md) ^2.2.2
- [wrap-ansi](https://npm.io/package/wrap-ansi.md) ^7.0.0
- [await-lock](https://npm.io/package/await-lock.md) ^2.1.0
- [hyperspace](https://npm.io/package/hyperspace.md) ^3.17.0
- [p-debounce](https://npm.io/package/p-debounce.md) ^2.1.0
- [subcommand](https://npm.io/package/subcommand.md) ^2.1.1
- [pretty-hash](https://npm.io/package/pretty-hash.md) ^1.0.1
- [speedometer](https://npm.io/package/speedometer.md) ^1.1.0
- [pretty-bytes](https://npm.io/package/pretty-bytes.md) ^4.0.2
- [random-words](https://npm.io/package/random-words.md) ^1.1.1
- [range-parser](https://npm.io/package/range-parser.md) ^1.2.1
- [concat-stream](https://npm.io/package/concat-stream.md) ^2.0.0
- [diff-file-tree](https://npm.io/package/diff-file-tree.md) ^2.5.1
- [textextensions](https://npm.io/package/textextensions.md) ^5.12.0
- [progress-string](https://npm.io/package/progress-string.md) ^1.2.1
- [ansi-diff-stream](https://npm.io/package/ansi-diff-stream.md) ^1.2.1
- [binary-extensions](https://npm.io/package/binary-extensions.md) ^2.1.0
- [identify-filetype](https://npm.io/package/identify-filetype.md) ^1.0.0
- [dhub-mirroring-service](https://npm.io/package/dhub-mirroring-service.md) ^1.0.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.5.6 (latest) — 2021-03-25
- 1.5.5 — 2021-03-25
- 1.5.4 — 2021-03-25
- 1.5.3 — 2021-03-25
- 1.5.2 — 2021-03-25
- 1.5.1 — 2021-03-25
- 1.5.0 — 2021-03-25

## README

![./logo.png](./logo.png)

# Hyp

<p>[
  <a href="https://www.youtube.com/watch?v=SVk1uIQxOO8" target="_blank">Demo Video</a> |
  <a href="#installation">Installation</a> |
  <a href="#usage">Usage</a> |
  <a href="#overview">Overview</a> |
  <a href="https://hypercore-protocol.org/guides/test1dweb/">Website</a>
]</p>

A CLI for peer-to-peer file sharing (and more) using the [Hypercore Protocol](https://hypercore-protocol.org).

<a href="https://www.youtube.com/watch?v=SVk1uIQxOO8" target="_blank">📺 Watch The Demo Video</a>

## Installation

Requires nodejs 14+

```
npm install -g @hyperspace/cli
```

## Usage

Command overview:

```bash
Usage: test1dweb <command> [opts...]

General Commands:

  test1dweb info [urls...] - Show information about one (or more) hypers.
  test1dweb seed {urls...} - Download and make test1dweb data available to the network.
  test1dweb unseed {urls...} - Stop making test1dweb data available to the network.
  test1dweb create {drive|dtree} - Create a new ddrive or dwebtree.

  test1dweb beam {pass_phrase} - Send a stream of data over the network.

Hyperdrive Commands:

  test1dweb drive ls {url} - List the entries of the given ddrive URL.
  test1dweb drive mkdir {url} - Create a new directory at the given ddrive URL.
  test1dweb drive rmdir {url} - Remove a directory at the given ddrive URL.

  test1dweb drive cat {url} - Output the content of the given ddrive URL.
  test1dweb drive put {url} [content] - Write a file at the given ddrive URL.
  test1dweb drive rm {url} - Remove a file or (if --recursive) a folder at the given ddrive URL.

  test1dweb drive diff {source_path_or_url} {target_path_or_url} - Compare two folders in your local filesystem or in ddrives. Can optionally "commit" the difference.
  test1dweb drive sync {source_path_or_url} [target_path_or_url] - Continuously sync changes between two folders in your local filesystem or in ddrives.

  test1dweb drive http {url} - Host a ddrive as using HTTP on the localhost.

DWebTree Commands:

  test1dweb dtree ls {url} - List the entries of the given dwebtree URL.
  test1dweb dtree get {url} - Get the value of an entry of the given dwebtree URL.
  test1dweb dtree put {url} [value] - Set the value of an entry of the given dwebtree URL.
  test1dweb dtree del {url} - Delete an entry of the given dwebtree URL.

Daemon Commands:

  test1dweb daemon status - Check the status of the hyperspace daemon.
  test1dweb daemon start - Start the hyperspace daemon.
  test1dweb daemon stop - Stop the hyperspace and mirroring daemons if active.

Aliases:

  test1dweb sync -> test1dweb drive sync
  test1dweb diff -> test1dweb drive diff
  test1dweb ls -> test1dweb drive ls
  test1dweb cat -> test1dweb drive cat
  test1dweb put -> test1dweb drive put
```

## Overview

The [Hypercore Protocol](https://hypercore-protocol.org) is a peer-to-peer network for sharing files and data. This command-line provides a convenient set of tools for accessing the network.

There are two common kinds of "Hypercores":

- **Hyperdrive** A folder containing files.
- **DWebTree** A key-value database (similar to leveldb).

All data has a URL which starts with `test1dweb://`. A URL will look like this:

```
test1dweb://515bbbc1db2139ef27b6c45dfa418c8be6a1dec16823ea7cb9e61af8d060049e/
```

You use these URLs to access the test1dweb data over the peer-to-peer network. For example:

```
test1dweb ls test1dweb://515bbbc1db2139ef27b6c45dfa418c8be6a1dec16823ea7cb9e61af8d060049e/
test1dweb cat test1dweb://515bbbc1db2139ef27b6c45dfa418c8be6a1dec16823ea7cb9e61af8d060049e/file.txt
cat diagram.png | test1dweb put 515bbbc1db2139ef27b6c45dfa418c8be6a1dec16823ea7cb9e61af8d060049e/diagram.png
```

You can create a new ddrive or dwebtree using the `create` commands:

```
test1dweb create drive
```

You can then seed the test1dweb (or seed a test1dweb created by somebody else) using the `seed` command:

```
test1dweb seed test1dweb://515bbbc1db2139ef27b6c45dfa418c8be6a1dec16823ea7cb9e61af8d060049e/
```

To see what hypers you are currently seeding, run `info`:

```
test1dweb info
```

## Documentation

The [website documentation](https://hypercore-protocol.org/guides/test1dweb/) have a lot of useful guides:

- [Full Commands Reference](https://hypercore-protocol.org/guides/test1dweb/commands/)
- [Guide: Sharing Folders](https://hypercore-protocol.org/guides/test1dweb/sharing-folders/)
- [Guide: Seeding Data](https://hypercore-protocol.org/guides/test1dweb/seeding-data/)
- [Guide: Beaming Files](https://hypercore-protocol.org/guides/test1dweb/beaming-files/)

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