Initial commit

Author: RandyMcMillan

.gitignore

@@ -0,0 +1,5 @@
+.app-data
+node_modules
+npm-debug.log
+package-lock.json
+.DS_Store

CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+- 1.2.0
+  - "sync" and "info" now default to non-live output.
+- 1.1.0
+  - Add "beam" command.
+  - Drives created by "sync" are now automatically seeded.
+- 1.0.0
+  - Initial release.

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Blue Link Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,145 @@
+# 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)
+
+<details><summary>Click to see the CLI README still</summary>
+  
+# 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/hyp/">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
+```
+
+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 <command> [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/)
+</details>

bin/hyp.js

@@ -0,0 +1,124 @@
+#!/usr/bin/env node
+
+
+process.title = "hyp"
+
+import subcommand from 'subcommand'
+import fs from 'fs'
+import path from 'path'
+import { fileURLToPath } from 'url'
+
+import * as hyper from '../lib/hyper/index.js'
+
+import info from '../lib/commands/info.js'
+import create from '../lib/commands/create.js'
+import seed from '../lib/commands/seed.js'
+import unseed from '../lib/commands/unseed.js'
+import beam from '../lib/commands/beam.js'
+
+import driveLs from '../lib/commands/drive/ls.js'
+import driveCat from '../lib/commands/drive/cat.js'
+import driveMkdir from '../lib/commands/drive/mkdir.js'
+import driveRmdir from '../lib/commands/drive/rmdir.js'
+import drivePut from '../lib/commands/drive/put.js'
+import driveRm from '../lib/commands/drive/rm.js'
+import driveDiff from '../lib/commands/drive/diff.js'
+import driveSync from '../lib/commands/drive/sync.js'
+import driveHttp from '../lib/commands/drive/http.js'
+
+import beeLs from '../lib/commands/bee/ls.js'
+import beeGet from '../lib/commands/bee/get.js'
+import beePut from '../lib/commands/bee/put.js'
+import beeDel from '../lib/commands/bee/del.js'
+
+import daemonStatus from '../lib/commands/daemon/status.js'
+import daemonStart from '../lib/commands/daemon/start.js'
+import daemonStop from '../lib/commands/daemon/stop.js'
+
+import usage from '../lib/usage.js'
+
+// main
+// =
+
+const commands = {
+  info,
+  seed,
+  unseed,
+  create,
+  beam,
+
+  driveLs,
+  driveCat,
+  driveMkdir,
+  driveRmdir,
+  drivePut,
+  driveRm,
+  driveDiff,
+  driveSync,
+  driveHttp,
+
+  beeLs,
+  beeGet,
+  beePut,
+  beeDel,
+
+  daemonStatus,
+  daemonStart,
+  daemonStop
+}
+
+// handle command aliases
+const driveCmdAliases = ['sync', 'diff', 'ls', 'cat', 'put']
+var argv = process.argv.slice(2)
+if (driveCmdAliases.includes(argv[0])) {
+  argv.unshift('drive')
+}
+
+// match & run the command
+var match = subcommand({ commands: Object.values(commands).map(wrapCommand), none })
+match(argv)
+
+// error output when no/invalid command is given
+function none (args) {
+  if (args.version) {
+    const packageJson = JSON.parse(fs.readFileSync(path.join(fileURLToPath(import.meta.url), '../../package.json'), 'utf8'))
+    console.log(packageJson.version)
+    process.exit(0)
+  }
+  if (args._[0]) {
+    console.error(`Invalid command: ${args._[0]}`)
+  } else {
+    usage(commands)
+  }
+}
+
+function wrapCommand (obj) {
+  var innerCommand = obj.command
+
+  obj.command = async function (...args) {
+    if (args[0].h || args[0].help) {
+      usage(commands, null, obj)
+      process.exit(0)
+    }
+
+    try {
+      if (!obj.name.startsWith('daemon') && obj.name !== 'beam') {
+        await hyper.setup()
+      }
+    } catch (err) {
+      console.error('The daemon is not active. Please run:')
+      console.error('')
+      console.error('  hyp daemon start')
+      console.error('')
+      process.exit(2)
+    }
+
+    try {
+      await innerCommand(...args)
+    } catch (err) {
+      console.error('Error:', err.message)
+      process.exit(1)
+    }
+  }
+  return obj
+}

docs/glossary.md

@@ -0,0 +1,14 @@
+# Glossary
+
+A collection of terms used in `hyp` and the [Hypercore Protocol](https://hypercore-protocol.org):
+
+- **Hypercore Protocol**. The network technology behind `hyp`. [See the website](https://hypercore-protocol.org).
+- **Hyperdrives**. A peer-to-peer files collection. [See the docs](https://github.com/hypercore-protocol/hyperdrive).
+- **Hyperbee**. A peer-to-peer key/value database. [See the docs](https://github.com/mafintosh/hyperbee).
+- **Hypercore**. An append-only log upon which Hyperdrives, Hyperbees, and any other hyper structure. [See the docs](https://github.com/hypercore-protocol/hypercore).
+- **Hypers** or **Hyper structures**. A short-hand for the various data structures (Hyperdrives, Hyperbees, etc).
+- **Hyperspace**. Two meanings:
+  - A general term for the ecosystem and network of the Hypercore Protocol.
+  - The name of the daemon program behind `hyp`. [See the docs](https://github.com/hypercore-protocol/hyperspace).
+- **Key**. The 64-character hex string that identifies hypers. The key is shared in hyper structure URLs with the `hyper://` scheme.
+- **Seeding**. Actively syncing the current data of a hyper-structure and hosting its data from your device for others to access.

docs/guides/beaming-data.md

@@ -0,0 +1,5 @@
+# Beaming data
+
+This doc was moved to the website:
+
+https://hypercore-protocol.org/guides/hyp/beaming-files/

docs/guides/creating-a-hyperdrive.md

@@ -0,0 +1,5 @@
+# Creating a hyperdrive
+
+This doc was moved to the website:
+
+https://hypercore-protocol.org/guides/hyp/commands/create/

docs/guides/diffing-a-hyperdrive.md

@@ -0,0 +1,5 @@
+# Diffing hyperdrives and local folders
+
+This doc was moved to the website:
+
+https://hypercore-protocol.org/guides/hyp/commands/drive-diff/

docs/guides/downloading-a-folder.md

@@ -0,0 +1,5 @@
+# Downloading a folder from a hyperdrive
+
+This doc was moved to the website:
+
+https://hypercore-protocol.org/guides/hyp/sharing-folders/