fs-cli

command module
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 20, 2023 License: Apache-2.0 Imports: 1 Imported by: 0

README

Go Reference Go Report Card

fs-cli

fs-cli is multi-threaded CLI app written in Golang to transfer multiple files concurrently via WebRTC.

It is peer-to-peer (P2P), so there are no servers in middle. However, Google's STUN server is used to retrieve information about public address and the type of NAT clients are behind. (Transfer of files does not happen through Google servers.)

This information is used to setup a Peer Connection between clients. After connecting, each file is assigned a WebRTC Data-Channel for streaming. And the transfer happens concurrently over all Data-Channels.

You can also find your public IP address via WebRTC. (See Usage Below)

https://github.com/spectre10/fs-cli/assets/72698233/fab8633b-af72-420c-9eff-3f91ada0eabc

Currently only tested on Linux.

Architecture

WebRTC

Installation

If you have Go installed, (Install from here)

Add $GOPATH/bin to your $PATH. And then,

if you want the latest release version, then run this command,

go install github.com/spectre10/fs-cli@latest

or

if you want a specific release version, then run this command,

go install github.com/spectre10/fs-cli@vX.X.X

Alternatively, you can also download from GitHub Releases.

Usage

To send a file,

fs-cli send <filepath1> <filepath2> ... 

To receive a file,

fs-cli receive

To find your IP address,

fs-cli findip

References

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
session

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL