Skip to content
A CLI tool designed to make interacting with Facebook's Open Source Library "Warp Speed Data Transfer" fast and pain-free.
Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
core
.gitignore
.gitmodules
LICENSE
Performance.md
README.md

README.md

Warp-CLI - Alpha v2.1

TLDR: Warp is a CLI tool designed to make interacting with Facebook's Warp Speed Data Transfer (WDT) pain-free.

Abstract

WDT is designed to provide the highest possible speed when transferring files(to be only hardware and network limited). WDT provides many advantages over most file transfer protocols including: native concurrency, end-to-end encryption, IPV6 support, and the ability to easily achieve +40Gbit speeds when supported. Unlike most file transfer solutions (Except NORM) WDT provides a native parallel solution for transferring files by separating files into chunks then queuing them across an arbitrary number of threads and TCP connections. In most cases, file transfer times are dramatically reduced compared to traditional methods like FTP or HTTP.

While WDT provides several benefits, it requires a comparatively lengthy build process. Additionally, if you are already using a modified version of SSH such as HPN-SSH, you are likely to see smaller performance gains. Since WDT is designed to fully saturate even the highest-end enterprise hardware, it will overwhelm your network. Please consider this when transferring more than a 1TB of files.

Performance Gains

Click the above link to get a detailed comparison of WDT performance compared to traditional file transfer protocols.

Design

Warp-CLI is mainly a wrapper for the limited existing CLI app provided by WDT. While the tool works extremely well, building performant commands for daily use is often unwieldy.

For example:
wdt -num_ports=8 -avg_mbytes_per_sec=100 -progress_report_interval_millis=5000 -overwrite=false -directory /dir/to/recv | ssh ssh.alias wdt -num_ports=8 -avg_mbytes_per_sec=100 -progress_report_interval_millis=5000 -overwrite=false -directory /dir/to/fetch/ -

Warp-CLI shortens this command to:
warp -f ssh.alias /dir/to/fetch/ /dir/to/recv

Demo_Gif

Warp.py can also be imported into any python3 script and then used independently of the CLI to send and receive directories.

CLI Usage

Warp-CLI features several shortcuts that attempt to make sending files as trivial and intuitive as possible.

Transfer Modes

Warp-CLI provides three core transfer modes:

  • -s, --ship: Send a remote directory to another remote directory.
    warp -s source_ssh /dir/to/send dest_ssh /dir/to/receive
  • -f, --fetch: Pull a remote directory to a local directory.
    warp -f source_ssh /dir/to/fetch /dir/to/receive
  • -p, --push: Send a local directory to a remote directory.
    warp -p /dir/to/push dest_ssh /dir/to/receive

Flags

  • -tr, --threads: default=8: You may want to raise or lower this depending on your hardware.
  • -ri, --report_interval: default=5000: This limits the heartbeat report to 5000 milliseconds(5 seconds).
  • -ts, --throttle_speed: default=-1: This setting throttles the transfer to an average mbytes per second.
  • -ow, --overwrite: Allow the receiver to overwrite existing files.
  • -sym, --follow_sym: Let WDT follow symlinks during transfer.

Macros

Warp-CLI also includes a macro system for repeating custom transfers with a single command. Macros are stored transfer commands (stored in ~/warp-cli/macros) that are invoked with warp -m macro_name.

To generate a macro:
warp -gm daily_backup -f source_ssh /dir/to/backup /dir/to/store/backup -ow -tr 16 -ri 10000 -cp '-skip_writes=true -start_port=12345'

This macro can now be called with:
warp -m daily_backup

Utilities

Warp-CLI provides a number of utilities and custom options to assist in more complicated transfers and WDT deployment.

  • -cp, --custom_parms: Inject any additional parameters available from wdt --help.
    warp -f /dir/to/receive source_ssh /dir/to/send -cp '-skip_writes=true -start_port=12345'
  • -m, --macro: Execute a custom macro from ~/warp-cli/config/ by name.
    warp -m macro_name
  • -gm, --gen_macro: Enter your transfer command as normal and include the gen_macro with a name for your new macro.
    warp -gm macro_name -f source_ssh /dir/to/fetch /dir/to/receive -tr 16 -ri 10000 -ow
  • -d, --daemon: Start a permanent receiver daemon on a local directory and export a file containing connection meta-data.
    warp --daemon /dir/to/receive
  • -i, --install: Attempt to install WDT and dependencies.
    warp --install
  • -ir, --install_remote: Attempt to install WDT and dependencies on a remote machine.
    warp -ir ssh.alias /dir/to/install
  • -rm, --uninstall: Uninstall Warp-CLI and config files.
    warp --uninstall

Setup - STILL UNDER DEVELOPMENT

Since WDT requires multiple dependencies, Warp-CLI attempts to provide a fully automated installation process for as many Linux flavors as possible. If your flavor is not supported, please refer to the manual install documentation. Once you install WDT and its dependencies Warp-CLI will function normally.

Automatic Installation

To install WDT and Warp-CLI automatically on your machine:

  1. sudo mkdir /usr/app && sudo chmod 777 /usr/app
  2. git clone --recurse-submodules https://github.com/JustinTimperio/warp-cli.git /usr/app/warp-cli
  3. python3 /usr/app/warp-cli/core/warp.py --install

So far, automatic installation is available on:

  • Arch Linux
  • Ubuntu 19.xx and 18.xx Workstation and Server
  • Debian 10.x and 9.x
  • Fedora 30, 29 and 28 Workstation and Server

Uninstall

Warp-CLI will remove itself from the machine but WDT will remain installed.
warp --uninstall

WDT Incompatible OS's

WDT requires CMAKE version > 3.2 or greater, making it incompatible on:

  • CentOS 7
  • Debian 8

OpenSSH for URL Sharing

Warp uses ssh to securely share connection URLs via a standard Linux pipe. It expects the use of an RSA key, which does not require a user password. While it is possible to use PAM authentication or key passwords, I have not yet added this as a feature.

URL Sharing Security While Using --ship

Warp-CLI uses the recommended method for transferring URLs except for the command to send directories between two remote machines. URLs are returned to the host rather than being tunneled through the remote machine to the next remote machine. This allows two remote servers to transfer files between one another without having the permission needed to connect directly via ssh.

SSH Aliases

Since Warp-CLI is designed mainly for daily use, it is highly recommended(if not assumed) that you already have an ssh alias for the server you are connecting to. If you don't have an existing SSH alias for the server you are transferring files to, please consider creating one.

You can’t perform that action at this time.