https://github.com/atek-cloud/spork

[CLI app] Peer-to-peer socket magic in the air
https://github.com/atek-cloud/spork

Last synced: 2 months ago
JSON representation

[CLI app] Peer-to-peer socket magic in the air

• Host: GitHub
• URL: https://github.com/atek-cloud/spork
• Owner: atek-cloud
• License: mit
• Archived: true
• Created: 2021-10-16T16:19:43.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2021-11-02T14:54:54.000Z (about 3 years ago)
• Last Synced: 2024-10-02T01:55:26.232Z (3 months ago)
• Language: TypeScript
• Homepage: https://spork.sh
• Size: 44.9 KB
• Stars: 289
• Watchers: 9
• Forks: 9
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-github-repos - atek-cloud/spork - [CLI app] Peer-to-peer socket magic in the air (TypeScript)
• awesome-starred - atek-cloud/spork - [CLI app] Peer-to-peer socket magic in the air (others)

README

        
![spork.svg](spork.svg)

# Atek Spork

A command-line p2p sockets tool.

```

npm i -g @atek-cloud/spork

```

## Overview

Spork lets you tunnel between any two devices using the [Hyperswarm P2P network](https://github.com/hyperswarm).

Here's the current commands:

```

spork - A p2p sockets multi-tool

Commands:

   spork bind [public-key] - Bind a p2p socket as a proxy to a local or remote server.

   spork gateway - Create an HTTP server that routes to p2p sockets by subdomain.

   spork serve {path} - Serve a folder as a static HTTP site over p2p sockets.

   spork beam [passphrase] - Create a encrypted network pipe.

```

**[Visit spork.sh](https://spork.sh/) for documentation**.

## Notable changes

### 1.0.0 - Drop libp2p modules

Breaking change.

The [Atek Networking module](https://github.com/atek-cloud/network) was updated to drop the libp2p modules. [See the section in that readme](https://github.com/atek-cloud/network#004---drop-libp2p-modules) to understand why.

This is a breaking change to the wire protocol from previous versions! Make sure you're using 1.0.0+ on both ends.

## License

MIT