Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hypercore-protocol/cli
A CLI for peer-to-peer file sharing using the Hypercore Protocol.
https://github.com/hypercore-protocol/cli
hyperbee hypercore hyperdrive hyperspace p2p
Last synced: 7 days ago
JSON representation
A CLI for peer-to-peer file sharing using the Hypercore Protocol.
- Host: GitHub
- URL: https://github.com/hypercore-protocol/cli
- Owner: hypercore-protocol
- License: mit
- Created: 2020-12-04T17:07:23.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-08-18T08:03:03.000Z (about 2 years ago)
- Last Synced: 2024-08-02T02:15:53.381Z (3 months ago)
- Topics: hyperbee, hypercore, hyperdrive, hyperspace, p2p
- Language: JavaScript
- Homepage:
- Size: 149 KB
- Stars: 205
- Watchers: 7
- Forks: 17
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-github-repos - hypercore-protocol/cli - A CLI for peer-to-peer file sharing using the Hypercore Protocol. (JavaScript)
- awesome-starred - hypercore-protocol/cli - A CLI for peer-to-peer file sharing using the Hypercore Protocol. (p2p)
README
# NOTE
The CLI is currently mostly out of date, tracking the previous major version of the Hypercore stack.
Check out the individual repos instead, like [Hypercore](https://github.com/hypercore-protocol/hypercore), [Hyperbee](https://github.com/hypercore-protocol/hyperbee), [Hyperbeam](https://github.com/mafintosh/hyperbeam), [Hyperswarm](https://github.com/hyperswarm)
Click to see the CLI README still
# Hyp
[
Demo Video |
Installation |
Usage |
Overview |
Website
]
A CLI for peer-to-peer file sharing (and more) using the [Hypercore Protocol](https://hypercore-protocol.org).
## Installation
Requires nodejs 14+
```
npm install -g @hyperspace/cli
```
To start using the network, run:
```
hyp daemon start
```
This will run in the background, sync data for you, until you run:
```
hyp daemon stop
```
## Usage
Command overview:
```bash
Usage: hyp [opts...]
General Commands:
hyp info [urls...] - Show information about one (or more) hypers.
hyp seed {urls...} - Download and make hyper data available to the network.
hyp unseed {urls...} - Stop making hyper data available to the network.
hyp create {drive|bee} - Create a new hyperdrive or hyperbee.
hyp beam {pass_phrase} - Send a stream of data over the network.
Hyperdrive Commands:
hyp drive ls {url} - List the entries of the given hyperdrive URL.
hyp drive mkdir {url} - Create a new directory at the given hyperdrive URL.
hyp drive rmdir {url} - Remove a directory at the given hyperdrive URL.
hyp drive cat {url} - Output the content of the given hyperdrive URL.
hyp drive put {url} [content] - Write a file at the given hyperdrive URL.
hyp drive rm {url} - Remove a file or (if --recursive) a folder at the given hyperdrive URL.
hyp drive diff {source_path_or_url} {target_path_or_url} - Compare two folders in your local filesystem or in hyperdrives. Can optionally "commit" the difference.
hyp drive sync {source_path_or_url} [target_path_or_url] - Continuously sync changes between two folders in your local filesystem or in hyperdrives.
hyp drive http {url} - Host a hyperdrive as using HTTP on the localhost.
Hyperbee Commands:
hyp bee ls {url} - List the entries of the given hyperbee URL.
hyp bee get {url} - Get the value of an entry of the given hyperbee URL.
hyp bee put {url} [value] - Set the value of an entry of the given hyperbee URL.
hyp bee del {url} - Delete an entry of the given hyperbee URL.
Daemon Commands:
hyp daemon status - Check the status of the hyperspace daemon.
hyp daemon start - Start the hyperspace daemon.
hyp daemon stop - Stop the hyperspace and mirroring daemons if active.
Aliases:
hyp sync -> hyp drive sync
hyp diff -> hyp drive diff
hyp ls -> hyp drive ls
hyp cat -> hyp drive cat
hyp put -> hyp 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.
- **Hyperbee** A key-value database (similar to leveldb).
All data has a URL which starts with `hyper://`. A URL will look like this:
```
hyper://515bbbc1db2139ef27b6c45dfa418c8be6a1dec16823ea7cb9e61af8d060049e/
```
You use these URLs to access the hyper data over the peer-to-peer network. For example:
```
hyp ls hyper://515bbbc1db2139ef27b6c45dfa418c8be6a1dec16823ea7cb9e61af8d060049e/
hyp cat hyper://515bbbc1db2139ef27b6c45dfa418c8be6a1dec16823ea7cb9e61af8d060049e/file.txt
cat diagram.png | hyp put 515bbbc1db2139ef27b6c45dfa418c8be6a1dec16823ea7cb9e61af8d060049e/diagram.png
```
You can create a new hyperdrive or hyperbee using the `create` commands:
```
hyp create drive
```
You can then seed the hyper (or seed a hyper created by somebody else) using the `seed` command:
```
hyp seed hyper://515bbbc1db2139ef27b6c45dfa418c8be6a1dec16823ea7cb9e61af8d060049e/
```
To see what hypers you are currently seeding, run `info`:
```
hyp info
```
## Documentation
The [website documentation](https://hypercore-protocol.org/guides/hyp/) have a lot of useful guides:
- [Full Commands Reference](https://hypercore-protocol.org/guides/hyp/commands/)
- [Guide: Sharing Folders](https://hypercore-protocol.org/guides/hyp/sharing-folders/)
- [Guide: Seeding Data](https://hypercore-protocol.org/guides/hyp/seeding-data/)
- [Guide: Beaming Files](https://hypercore-protocol.org/guides/hyp/beaming-files/)