You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-10Lines changed: 11 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,13 @@
1
-
# Warp-CLI - _Alpha v2.1_
1
+
# Warp-CLI - _Alpha v2.1_
2
2
TLDR: Warp is a CLI tool designed to make interacting with Facebook's [Warp Speed Data Transfer (WDT)](https://github.com/facebook/wdt) pain-free.
3
3
4
4
## Abstract
5
5
[WDT](https://github.com/facebook/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](https://www.nrl.navy.mil/itd/ncs/products/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.
6
6
7
-
While WDT provides several benefits, it requires comparatively lengthy build process. Additionally, if you are already using a modified version of SSH such as [HPN-SSH](https://www.psc.edu/hpn-ssh), you are likely to see smaller performance gains. Since WDT is designed to fully saturate even the highest-end enterprise hardware, it is likely to overwhelm your network. Please consider this when transferring more than a 1TB of files.
7
+
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](https://www.psc.edu/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.
Click the above link to get a detailed comparison of WDT performance compared to traditional file transfer protocols.
10
11
11
12
## Design
12
13
Warp-CLI is mainly a wrapper for the limited existing [CLI app provided by WDT](https://github.com/facebook/wdt/wiki/Getting-Started-with-the-WDT-command-line). While the tool works extremely well, building performant commands for daily use is often unwieldy.
@@ -22,7 +23,7 @@ Warp-CLI shortens this command to:\
22
23
Warp.py can also be imported into any python3 script and then used independently of the CLI to send and receive directories.
23
24
24
25
## CLI Usage
25
-
Warp-CLI features a number of shortcuts that attempt to make sending files as trivial and intuitive as possible.
26
+
Warp-CLI features several shortcuts that attempt to make sending files as trivial and intuitive as possible.
26
27
27
28
### Transfer Modes
28
29
Warp-CLI provides three core transfer modes:
@@ -34,9 +35,9 @@ Warp-CLI provides three core transfer modes:
34
35
`warp -p /dir/to/push dest_ssh /dir/to/receive`
35
36
36
37
### Flags
37
-
-`-tr, --threads` - default=8: You may want to raise or lower this depending on your hardware.
38
-
-`-ri, --report_interval`- default=5000: This limits the heartbeat report to 5000 milliseconds(5 seconds).
39
-
-`-ts, --throttle_speed` - default=-1: This setting throttles the transfer to an average mbytes per second.
38
+
-`-tr, --threads`: default=8: You may want to raise or lower this depending on your hardware.
39
+
-`-ri, --report_interval`: default=5000: This limits the heartbeat report to 5000 milliseconds(5 seconds).
40
+
-`-ts, --throttle_speed`: default=-1: This setting throttles the transfer to an average mbytes per second.
40
41
-`-ow, --overwrite`: Allow the receiver to overwrite existing files.
41
42
-`-sym, --follow_sym`: Let WDT follow symlinks during transfer.
42
43
@@ -50,15 +51,15 @@ This macro can now be called with:\
50
51
`warp -m daily_backup`
51
52
52
53
### Utilities
53
-
Warp-CLI provides a number of utilities to streamline the daily use of WTD when sending files in high frequency.
54
+
Warp-CLI provides a number of utilities and custom options to assist in more complicated transfers and WDT deployment.
54
55
55
56
- -cp, --custom_parms: Inject any additional parameters available from `wdt --help`.\
- -d, --daemon: Start a permanent receiver daemon on a local directory and export a file containing the connection URL and meta-data.\
62
+
- -d, --daemon: Start a permanent receiver daemon on a local directory and export a file containing connection meta-data.\
62
63
`warp --daemon /dir/to/receive`
63
64
- -i, --install: Attempt to install WDT and dependencies.\
64
65
`warp --install`
@@ -68,15 +69,15 @@ Warp-CLI provides a number of utilities to streamline the daily use of WTD when
68
69
`warp --uninstall`
69
70
70
71
## Setup - _STILL UNDER DEVELOPMENT_
71
-
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](https://github.com/facebook/wdt/blob/master/build/BUILD.md). Once you install WDT and its dependencies Warp-CLI will function normally.
72
+
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](https://github.com/facebook/wdt/blob/master/build/BUILD.md). Once you install WDT and its dependencies Warp-CLI will function normally.
72
73
73
74
### Automatic Installation
74
75
To install WDT and Warp-CLI automatically on your machine:
0 commit comments