yetangitu/ffsend
1
0
Fork 0
mirror of https://github.com/timvisee/ffsend.git synced 2025-10-03 17:49:15 +02:00
Code Issues Projects Releases Packages Wiki Activity

Add usage demo vidoe/GIF/asciinema

Browse source
This commit is contained in:
timvisee 2018-05-18 14:45:00 +02:00
parent bec08c57ed
commit 5f1947d171
No known key found for this signature in database
GPG key ID: A28432A0AE6E6306
7 changed files with 1264 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

54
README.md
View file

@ -10,10 +10,7 @@ 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 to 2GB. Others are able to download these files with this tool, or through
their webbrowser. their webbrowser.
```bash [![ffsend usage demo](./res/ffsend-demo.gif)](./res/ffsend-demo.mp4)
$ ffsend upload my-file.txt
Share link: https://send.firefox.com/#sample-share-url
```
All files are always encrypted on the client, and secrets are never shared with 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 the remote host. An optional password may be specified, and a default file
@ -49,6 +46,9 @@ _Note: this tool is currently in the alpha phase_
- Accurate error reporting - Accurate error reporting
- Intended to be used in scripts without interaction - Intended to be used in scripts without interaction
For a list of upcoming features and ideas, take a look at the
[ROADMAP](ROADMAP.md) file.
## Usage ## Usage
Easily upload and download: Easily upload and download:
@ -96,7 +96,7 @@ Other commands include:
```bash ```bash
# View your file history # View your file history
$ ffsend history $ ffsend history
# URL EXPIRY OWNER TOKEN # LINK EXPIRY OWNER TOKEN
1 https://send.firefox.com/#sample-share-url 23h57m eea9f544f6d5df8a5afd 1 https://send.firefox.com/#sample-share-url 23h57m eea9f544f6d5df8a5afd
2 https://send.firefox.com/#other-sample-url 17h38m 1e9fef63fee3baaf54ce 2 https://send.firefox.com/#other-sample-url 17h38m 1e9fef63fee3baaf54ce
3 https://example.com/#sample-share-url 37m30s 8eb28bc1bc85cfdab0e4 3 https://example.com/#sample-share-url 37m30s 8eb28bc1bc85cfdab0e4
@ -109,7 +109,8 @@ Password: ******
$ ffsend delete https://send.firefox.com/#sample-share-url $ ffsend delete https://send.firefox.com/#sample-share-url
``` ```
Use the `--help` flag, or see the [help](#help) section for all available subcommands. Use the `--help` flag, `help` subcommand, or see the [help](#help) section for
all available subcommands.
## Requirements ## Requirements
- Linux, macOS or Windows - Linux, macOS or Windows
@ -226,28 +227,29 @@ cargo install --no-default--features --features history,clipboard
## Configuration and environment ## Configuration and environment
The following environment variables may be used to configure the following The following environment variables may be used to configure the following
defaults: defaults. The CLI flag is shown along with it, to better describe the relation
to command line arguments:
| Variable | CLI flag | Description | | Variable | CLI flag | Description |
| :--------------- | :---------: | :---------------- | | :--------------- | :----------------: | :---------------- |
| `FFSEND_HISTORY` | `-H <FILE>` | History file path | | `FFSEND_HISTORY` | `--history <FILE>` | History file path |
| `FFSEND_HOST` | `-h <HOST>` | Upload host | | `FFSEND_HOST` | `--host <URL>` | Upload host |
These environment variables may be used to toggle a flag, simply by making them These environment variables may be used to toggle a flag, simply by making them
available. The actual value of these variables is ignored, and variables may be available. The actual value of these variables is ignored, and variables may be
empty. empty.
| Variable | CLI flag | Description | | Variable | CLI flag | Description |
| :------------------- | :------: | :-------------------------------- | | :------------------- | :-------------: | :-------------------------------- |
| `FFSEND_FORCE` | `-f` | Force operations | | `FFSEND_FORCE` | `--force` | Force operations |
| `FFSEND_NO_INTERACT` | `-I` | No interaction for prompts | | `FFSEND_NO_INTERACT` | `--no-interact` | No interaction for prompts |
| `FFSEND_YES` | `-y` | Assume yes for prompts | | `FFSEND_YES` | `--yes` | Assume yes for prompts |
| `FFSEND_INCOGNITO` | `-i` | Incognito mode, don't use history | | `FFSEND_INCOGNITO` | `--incognito` | Incognito mode, don't use history |
| `FFSEND_OPEN` | `-o` | Open share link of uploaded file | | `FFSEND_OPEN` | `--open` | Open share link of uploaded file |
| `FFSEND_ARCHIVE` | `-a` | Archive files uploaded | | `FFSEND_ARCHIVE` | `--archive` | Archive files uploaded |
| `FFSEND_EXTRACT` | `-e` | Extract files downloaded | | `FFSEND_EXTRACT` | `--extract` | Extract files downloaded |
| `FFSEND_COPY` | `-c` | Copy share link to clipboard | | `FFSEND_COPY` | `--copy` | Copy share link to clipboard |
| `FFSEND_VERBOSE` | `-v` | Log verbose information | | `FFSEND_VERBOSE` | `--verbose` | Log verbose information |
At this time, no configuration or _dotfile_ file support is available. At this time, no configuration or _dotfile_ file support is available.
This will be something added in a later release. This will be something added in a later release.
@ -293,11 +295,11 @@ This application is not affiliated with Mozilla, Firefox or Firefox Send.
``` ```
## License ## License
This tool is released under the GNU GPL-3.0 license. Check out the The tool `ffsend` itself is released under the GNU GPL-3.0 license.
[LICENSE](LICENSE) file for more information. Check out the [LICENSE](LICENSE) file for more information.
The included API library located [here](api) is intended for use in other The `ffsend-api` library that is part of this repository located [here](api),
projects and is is released under the MIT license. 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. Check out the [LICENSE](api/LICENSE) file for more information.
[firefox]: https://firefox.com/ [firefox]: https://firefox.com/

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

@ -57,7 +57,7 @@ impl<'a> History<'a> {
table.set_format(FormatBuilder::new().padding(0, 2).build()); table.set_format(FormatBuilder::new().padding(0, 2).build());
table.add_row(Row::new(vec![ table.add_row(Row::new(vec![
Cell::new("#"), Cell::new("#"),
Cell::new("URL"), Cell::new("LINK"),
Cell::new("EXPIRY"), Cell::new("EXPIRY"),
Cell::new("OWNER TOKEN"), Cell::new("OWNER TOKEN"),
])); ]));

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

@ -222,7 +222,7 @@ impl<'a> Upload<'a> {
let mut table = Table::new(); let mut table = Table::new();
table.set_format(FormatBuilder::new().padding(0, 2).build()); table.set_format(FormatBuilder::new().padding(0, 2).build());
table.add_row(Row::new(vec![ table.add_row(Row::new(vec![
Cell::new("Share URL:"), Cell::new("Share link:"),
Cell::new(url.as_str()), Cell::new(url.as_str()),
])); ]));
if matcher_main.verbose() { if matcher_main.verbose() {

1222
res/asciinema-ffsend-demo.json Normal file
View file

File diff suppressed because it is too large Load diff

12
res/create-gif-ffsend-demo Executable file
View file

@ -0,0 +1,12 @@
#!/bin/bash
# Create the frames directory
mkdir frames
# Extract the frames
ffmpeg -i ./ffsend-demo.mp4 -r 6/1 frames/frame%04d.png
# Create a gif
gifski -o ffsend-demo.gif frames/frame*.png --width 850 --height 332 --fps 6 --quality 70
echo "Done"

BIN
res/ffsend-demo.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 8 MiB

BIN
res/ffsend-demo.mp4 Normal file
View file

Binary file not shown.