beenull/ffsend
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add asciinema link to README, change URL to link

Browse source
This commit is contained in:
timvisee 2018-05-18 16:51:07 +02:00
parent 5f1947d171
commit 70e7b7fffa
No known key found for this signature in database
GPG key ID: 109CBA0BF74036C2
8 changed files with 27 additions and 54 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -1,6 +1,6 @@
[![Build status on Travis CI][travis-master-badge]][travis-link]
# ffsend
# ffsend [WIP]
> Securely and easily share files from the command line.
> A fully featured [Firefox Send][send] client.
@ -10,7 +10,8 @@ Files are shared using the [Send][send] service and may be up
to 2GB. Others are able to download these files with this tool, or through
their webbrowser.
[![ffsend usage demo](./res/ffsend-demo.gif)](./res/ffsend-demo.mp4)
[![ffsend usage demo][usage-demo-gif]][usage-demo-mp4]
_View as [asciinema][usage-demo-asciinema] or [MP4][usage-demo-mp4]._
All files are always encrypted on the client, and secrets are never shared with
the remote host. An optional password may be specified, and a default file
@ -30,7 +31,8 @@ Find out more about security [here](#security).
The public [Send][send] service that is used as default host is provided by
[Mozilla][mozilla].
This application is not affiliated with [Mozilla][mozilla], [Firefox][firefox] or [Firefox Send][send].
This application is not affiliated with [Mozilla][mozilla], [Firefox][firefox]
or [Firefox Send][send] in any way.
_Note: this tool is currently in the alpha phase_
@ -61,8 +63,8 @@ Share link: https://send.firefox.com/#sample-share-url
# - Specify a download limit of 20
# - Enter a password to encrypt the file
# - Archive the file before uploading
# - Copy the shareable URL to your clipboard
# - Open the shareable URL in your browser
# - Copy the shareable link to your clipboard
# - Open the shareable link in your browser
$ ffsend upload --downloads 20 --password --archive --copy --open my-file.txt
Password: ******
Share link: https://send.firefox.com/#sample-share-url
@ -302,6 +304,9 @@ The `ffsend-api` library that is part of this repository located [here](api),
is intended for use in other projects and is is released under the MIT license.
Check out the [LICENSE](api/LICENSE) file for more information.
[usage-demo-asciinema]: https://asciinema.org/a/182225
[usage-demo-gif]: ./res/ffsend-demo.gif
[usage-demo-mp4]: ./res/ffsend-demo.mp4?raw=true
[firefox]: https://firefox.com/
[git]: https://git-scm.com/
[libressl]: https://libressl.org/

4
REQUIREMENTS.md
View file

@ -20,5 +20,5 @@ toolchain.
- `FFSEND_OPEN`: open an uploaded file (present/boolean)
- `FFSEND_ARCHIVE`: enable file archival (present/boolean)
- `FFSEND_EXTRACT`: enable file extraction (present/boolean)
- `FFSEND_COPY`: copy share URL to clipboard (present/boolean)
- `FFSEND_VERBOSE`: copy share URL to clipboard (present/boolean)
- `FFSEND_COPY`: copy share link to clipboard (present/boolean)
- `FFSEND_VERBOSE`: copy share link to clipboard (present/boolean)

6
cli/src/action/delete.rs
View file

@ -39,13 +39,13 @@ impl<'a> Delete<'a> {
let matcher_main = MainMatcher::with(self.cmd_matches).unwrap();
let matcher_delete = DeleteMatcher::with(self.cmd_matches).unwrap();
// Get the share URL
// Get the share link
let url = matcher_delete.url();
// Create a reqwest client
let client = Client::new();
// Parse the remote file based on the share URL, derive the owner token from history
// Parse the remote file based on the share link, derive the owner token from history
let mut file = RemoteFile::parse_url(url, matcher_delete.owner())?;
#[cfg(feature = "history")]
history_tool::derive_file_properties(&matcher_main, &mut file);
@ -77,7 +77,7 @@ impl<'a> Delete<'a> {
pub enum Error {
/// Failed to parse a share URL, it was invalid.
/// This error is not related to a specific action.
#[fail(display = "invalid share URL")]
#[fail(display = "invalid share link")]
InvalidUrl(#[cause] FileParseError),
/// Could not delete, the file has expired or did never exist.

2
cli/src/action/download.rs
View file

@ -353,7 +353,7 @@ impl<'a> Download<'a> {
pub enum Error {
/// Failed to parse a share URL, it was invalid.
/// This error is not related to a specific action.
#[fail(display = "invalid share URL")]
#[fail(display = "invalid share link")]
InvalidUrl(#[cause] FileParseError),
/// An error occurred while checking if the file exists.

2
cli/src/action/exists.rs
View file

@ -72,7 +72,7 @@ impl<'a> Exists<'a> {
pub enum Error {
/// Failed to parse a share URL, it was invalid.
/// This error is not related to a specific action.
#[fail(display = "invalid share URL")]
#[fail(display = "invalid share link")]
InvalidUrl(#[cause] FileParseError),
/// An error occurred while checking if the file exists.

2
cli/src/action/info.rs
View file

@ -175,7 +175,7 @@ impl<'a> Info<'a> {
pub enum Error {
/// Failed to parse a share URL, it was invalid.
/// This error is not related to a specific action.
#[fail(display = "invalid share URL")]
#[fail(display = "invalid share link")]
InvalidUrl(#[cause] FileParseError),
/// An error occurred while checking if the file exists.

4
cli/src/action/upload.rs
View file

@ -241,7 +241,7 @@ impl<'a> Upload<'a> {
if matcher_upload.open() {
if let Err(err) = open_url(&url) {
print_error(
err.context("failed to open the URL in the browser")
err.context("failed to open the share link in the browser")
);
};
}
@ -250,7 +250,7 @@ impl<'a> Upload<'a> {
#[cfg(feature = "clipboard")] {
if matcher_upload.copy() {
if let Err(err) = set_clipboard(url.as_str().to_owned()) {
print_error(err.context("failed to copy the URL to the clipboard, ignoring"));
print_error(err.context("failed to copy the share link to the clipboard, ignoring"));
}
}
}

46
res/asciinema-ffsend-demo.json
View file

@ -4,50 +4,18 @@
"height": 19,
"duration": 78.431135,
"command": null,
"title": null,
"title": "ffsend v0.0.1 demo",
"env": {
"TERM": "xterm-256color",
"SHELL": "/bin/bash"
},
"stdout": [
[
0.315246,
"\u001b[01;34m~/ffsend\u001b[00m $ "
],
[
0.299284,
"c"
],
[
0.075151,
"l"
],
[
0.082658,
"e"
],
[
0.005495,
"a"
],
[
0.06475,
"r"
],
[
0.05582,
"\r\n"
],
[
0.002588,
"\u001b[3J\u001b[H\u001b[2J"
],
[
0.000446,
"\u001b[01;34m~/ffsend\u001b[00m $ "
],
[
2.747628,
1,
"f"
],
[
@ -224,7 +192,7 @@
],
[
0.004434,
"\rEncrypt & Upload 116.93 KB / 116.93 KB [=======================================] 100.00 % 26.44 MB/s \rUpload complete "
"\rEncrypt & Upload 116.93 KB / 116.93 KB [=======================================] 100.00 % 26.44 MB/s \rUpload complete\r\n"
],
[
0.000379,
@ -332,7 +300,7 @@
],
[
0.002159,
"\rDownload & Decrypt 116.93 KB / 116.93 KB [=====================================] 100.00 % 46.05 MB/s \rDownload complete "
"\rDownload & Decrypt 116.93 KB / 116.93 KB [=====================================] 100.00 % 46.05 MB/s \rDownload complete\r\n"
],
[
0.00258,
@ -752,7 +720,7 @@
],
[
0.000241,
"\rUpload complete "
"\rUpload complete\r\n"
],
[
0.007118,
@ -940,7 +908,7 @@
],
[
0.005111,
"\rDownload & Decrypt 589.02 KB / 589.02 KB [====================================] 100.00 % 105.05 MB/s \rDownload complete "
"\rDownload & Decrypt 589.02 KB / 589.02 KB [====================================] 100.00 % 105.05 MB/s \rDownload complete\r\n"
],
[
0.001558,
@ -1219,4 +1187,4 @@
"\u001b[01;34m~/ffsend\u001b[00m $ "
]
]
}
}