transfer files (even massives one) fully on your LAN, using a fully headless CLI tool!

showcases

to view the project's showcases, please click on one of the two video avalaible. the first video showcases the main file transfer part of the project, while the second video showcases the speedtest part.

table of contents

• compatibility
• features
• commands list
• installation
  • with npm: Linux, macOS, Windows
  • install from source
• uninstall
• reporting issues
• privacy information
• license

compatibility

this project works and can be installed on any device running nodeJS, that being mostly Linux, Windows, and macOS, but it can be installed on Android with terminal emulators for example!
compatibility with devices running anything else than macOS, Linux, or Windows has been untested and is gonna be random.

features

this project was originally meant to just be a file transfer tool, but it became a bit more than that! with this project, you may:

• transfer files from a device to another, cross-platform, by just installing a npm package!
• make sure the files didn't get corrupted (that's not really a feature but it's a good thing to have ig)
• test the max capabilities of your network card with a fully LAN-based speedtest tool!
• host a file sharing server and a speedtest server fully headless, just on a CLI!

commands

here's a list of commands, organized by category:

file sharing/transfer

• transfer host [--path '/home/lolodotzip/hi'] : start a share server allowing you to recieve files on the device you start it on. you may use '--path' to recieve files to a specific path.
• transfer discover : lists all the devices currently hosting a share session on your LAN.
• transfer send <IP/ID/hostname> [--rename "newName"] : sends the file you pass in the argument to the device you specify. you may use the device's hostname, IP address, or ID (the last octet of the IP, e.g '31' for '192.168.1.31'). you can also use '--rename' to edit the file name the device will recieve.

speed testing

• transfer speed info : small reminder about the technical terms of Ethernet and it's designations.
• transfer speed host : start a speedtest server for another device to test it's max LAN speed.
• transfer speed test <IP/ID/hostname> : runs a 10 second test on the speedtest server host, testing the max possible speed. you may either use the host's IP address, hostname, or ID (the last octet of the IP, e.g '31' for '192.168.1.31').

installation

npm: Linux, macOS, Windows

you can install this project by simply getting it from npm:

npm install -g transfernoclutter
transfer help

install from source

to install from source, you must start by making sure you have git, nodeJS, and npm installed. then, start by cloning the repository:

git clone https://github.com/Lolo280374/transfernoclutter.git
cd transfernoclutter

you may then install the dependencies, and link the package to your system:

npm install
npm link

once complete, you can run the following to make sure the installation suceeded, and you can start editing 'index.js' to make modifs!

transfer help

uninstall

to uninstall, you can simply run the following:

npm uninstall -g transfernoclutter

reporting issues

this is a community project, and your help is very much appreciated! if you notice anything wrong durign your usage of this project, please report it on the GitHub issues tracker!

privacy disclaimer

this tool dosen't collect any analytics of any sort, nor makes connections to the outside of the Internet. all the connections made are being made on your LAN (Local Area Network), meaning it's all private!

license

this project is licensed under the MIT license. you can check it here.
if you have any questions about this project, please reach me at lolodotzip@hackclub.app.