Skip to content

Commit 53d6ef7

Browse files
Update README.md
1 parent 1af0b1a commit 53d6ef7

1 file changed

Lines changed: 11 additions & 10 deletions

File tree

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1-
# Warp-CLI - _Alpha v2.1_
1+
# Warp-CLI - _Alpha v2.1_
22
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.
33

44
## Abstract
55
[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.
66

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.
88

99
### [Performance Gains](https://github.com/JustinTimperio/warp-cli/blob/master/Performance.md)
10+
Click the above link to get a detailed comparison of WDT performance compared to traditional file transfer protocols.
1011

1112
## Design
1213
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:\
2223
Warp.py can also be imported into any python3 script and then used independently of the CLI to send and receive directories.
2324

2425
## 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.
2627

2728
### Transfer Modes
2829
Warp-CLI provides three core transfer modes:
@@ -34,9 +35,9 @@ Warp-CLI provides three core transfer modes:
3435
`warp -p /dir/to/push dest_ssh /dir/to/receive`
3536

3637
### 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.
4041
- `-ow, --overwrite`: Allow the receiver to overwrite existing files.
4142
- `-sym, --follow_sym`: Let WDT follow symlinks during transfer.
4243

@@ -50,15 +51,15 @@ This macro can now be called with:\
5051
`warp -m daily_backup`
5152

5253
### 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.
5455

5556
- -cp, --custom_parms: Inject any additional parameters available from `wdt --help`.\
5657
`warp -f /dir/to/receive source_ssh /dir/to/send -cp '-skip_writes=true -start_port=12345'`
5758
- -m, --macro: Execute a custom macro from ~/warp-cli/config/ by name.\
5859
`warp -m macro_name`
5960
- -gm, --gen_macro: Enter your transfer command as normal and include the gen_macro with a name for your new macro.\
6061
`warp -gm macro_name -f source_ssh /dir/to/fetch /dir/to/receive -tr 16 -ri 10000 -ow`
61-
- -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.\
6263
`warp --daemon /dir/to/receive`
6364
- -i, --install: Attempt to install WDT and dependencies.\
6465
`warp --install`
@@ -68,15 +69,15 @@ Warp-CLI provides a number of utilities to streamline the daily use of WTD when
6869
`warp --uninstall`
6970

7071
## 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.
7273

7374
### Automatic Installation
7475
To install WDT and Warp-CLI automatically on your machine:
7576
1. `sudo mkdir /usr/app && sudo chmod 777 /usr/app`
7677
2. `git clone --recurse-submodules https://github.com/JustinTimperio/warp-cli.git /usr/app/warp-cli`
7778
3. `python3 /usr/app/warp-cli/core/warp.py --install`
7879

79-
So far, automatic installation is available on:
80+
**So far, automatic installation is available on:**
8081
- Arch Linux
8182
- Ubuntu 19.xx and 18.xx Workstation and Server
8283
- Debian 10.x and 9.x

0 commit comments

Comments
 (0)