Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hackergrrl/hpad
:page_facing_up: Peer-to-peer documents from the command line.
https://github.com/hackergrrl/hpad
Last synced: 1 day ago
JSON representation
:page_facing_up: Peer-to-peer documents from the command line.
- Host: GitHub
- URL: https://github.com/hackergrrl/hpad
- Owner: hackergrrl
- Created: 2017-11-02T23:13:48.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2017-11-10T05:27:57.000Z (almost 7 years ago)
- Last Synced: 2024-09-03T14:20:09.669Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 18.6 KB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# hpad
> Create and edit peer-to-peer documents with your favourite text editor, then
> sync them to peers from the command line!
A command line interface of *[hyperpad](https://github.com/noffle/hyperpad)*.
## Usage
1. run `hpad init FILE` on a new or existing document on your computer
2. edit `FILE` whenever you want in your favourite text editor
3. share the `KEY` outputted by `hpad init` with your friends
4. `hpad seed FILE` to share your changes & pull others online and from the
local network
5. all changes pulled automatically update your local copy of `FILE`
## Example
```
eliza$ hpad init foo.markdown
[8029129c219e9ff63901f4f9] created hyperpad for foo.markdown
eliza$ vim foo.markdown
(edit edit edit)
eliza$ cat foo.markdown
hello world
eliza$ hpad seed foo.markdown
[8029129c219e9ff63901f4f9] joining swarm for foo.markdown
Press CTRL+C to terminate synchronization..
jorge$ hpad clone 8029129c219e9ff63901f4f9
[8029129c219e9ff63901f4f9] joining swarm for 8029129c219e9ff63901f4f9
found peer 10.30.66.206|3497
replicating to peer 10.30.66.206|3497.. done!
jorge$ atom foo.markdown
(edit edit edit)
jorge$ cat foo.markdown
hello world!
wow p2p so fresh
jorge$ hpad seed foo.markdown
[8029129c219e9ff63901f4f9] joining swarm for foo.markdown
found peer ::ffff:10.30.66.206|3259
replicating to peer ::ffff:10.30.66.206|3259.. done!
Press CTRL+C to terminate synchronization..
eliza$ cat foo.markdown
hello world!
wow p2p so fresh
```
## CLI Usage
```
USAGE:
hpad init FILE
Start backing FILE with hyperpad. Outputs the KEY for the new pad.
hpad clone KEY
Create a local copy of a hyperpad document from the swarm.
hpad seed FILE
Join the swarm for this document online & on the local network to
share and exchange updates. Command runs until manually terminated.
hpad ls
List all hyperpad documents in the current directory, and their keys.
```
## Values
1. no lock-in: let everyone keep using the editors they like in plaintext
2. peer-to-peer: no central servers or corporate ownership
3. open source: hack and fork the world!
## Install
With [npm](https://npmjs.org/) installed, run
```
$ npm install --global hpad
```
## License
ISC