diff --git a/README.md b/README.md index 1ac35d5..a7a49f2 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,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][usage-demo-gif]][usage-demo-mp4] -_View as [asciinema][usage-demo-asciinema] or [MP4][usage-demo-mp4]._ +[![ffsend usage demo](./res/demo.svg)](./res/demo.svg?raw=true) +_Or view as [asciinema][usage-demo-asciinema]._ 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 @@ -356,8 +356,6 @@ This project is released under the GNU GPL-3.0 license. Check out the [LICENSE](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/ diff --git a/ROADMAP.md b/ROADMAP.md index 6893384..ab7704e 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -3,6 +3,8 @@ The first release used for gathering feedback on the application by selected people. Features: +- Do not show default values for `--host`, see `ffsend help upload` +- History clear command - Ask to remove a file when downloading failed - Polish command outputs, make it consistent (format, color) - Automated releases through CI diff --git a/res/asciinema-ffsend-demo.json b/res/asciinema-demo.json similarity index 100% rename from res/asciinema-ffsend-demo.json rename to res/asciinema-demo.json diff --git a/res/asciinema-to-svg b/res/asciinema-to-svg new file mode 100755 index 0000000..33588d1 --- /dev/null +++ b/res/asciinema-to-svg @@ -0,0 +1,13 @@ +#!/bin/bash + +# Ensure svg-term is installed +if ! [ -x "$(command -v svg-term)" ]; then + echo "svg-term is not installed, unable to create SVG, use:" + echo "sudo npm install -g svg-term-cli" + exit 1 +fi + +# Convert into a GIF +echo "Generating SVG..." +cat asciinema-demo.json | svg-term --out demo.svg --window +echo "Done" diff --git a/res/create-gif-ffsend-demo b/res/create-gif-ffsend-demo deleted file mode 100755 index 3b8277f..0000000 --- a/res/create-gif-ffsend-demo +++ /dev/null @@ -1,12 +0,0 @@ -#!/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" diff --git a/res/demo.svg b/res/demo.svg new file mode 100644 index 0000000..428378e --- /dev/null +++ b/res/demo.svg @@ -0,0 +1 @@ +~/ffsend$~/ffsend$f~/ffsend$ff~/ffsend$ffs~/ffsend$ffse~/ffsend$ffsen~/ffsend$ffsendffsend0.0.1Usage:ffsend[FLAGS]<SUBCOMMAND>...Securelyandeasilysharefilesfromthecommandline.AfullyfeaturedFirefoxSendclient.Missingsubcommand.Herearethemostused:ffsendupload<FILE>...ffsenddownload<URL>...Toshowallsubcommands,featuresandotherhelp:ffsendhelp[SUBCOMMAND]~/ffsend$ffsendu~/ffsend$ffsendup~/ffsend$ffsendupl~/ffsend$ffsenduplo~/ffsend$ffsenduploa~/ffsend$ffsendupload~/ffsend$ffsenduploadimage.png~/ffsend$ffsenduploadimage.png--copyUploadcompleted116.93KB/116.93KB[=======================================]100.00%26.44MB/sSharelink:http://send.firefox.com/download/eb2ab818cc/#F8_WgM3tz1t05yiPMsBgIw~/ffsend$ffsendd~/ffsend$ffsenddo~/ffsend$ffsenddow~/ffsend$ffsenddown~/ffsend$ffsenddownl~/ffsend$ffsenddownlo~/ffsend$ffsenddownloa~/ffsend$ffsenddownload~/ffsend$ffsenddownloadhttp://send.firefox.com/download/eb2ab818cc/#F8_WgM3tz1t05yiPMsBgIwThepath'/home/timvisee/ffsend/image.png'alreadyexistsOverwrite?[y/n]:yDownloadcompletet116.93KB/116.93KB[=====================================]100.00%46.05MB/s~/ffsend$c~/ffsend$cl~/ffsend$cle~/ffsend$clea~/ffsend$clear~/ffsend$t~/ffsend$tr~/ffsend$tre~/ffsend$tree.├──dir│├──image1.png│├──image2.png│├──image3.png│├──image4.png│└──image5.png└──image.png1directory,6files~/ffsend$ffsendupload--host~/ffsend$ffsendupload--hosthttp://localhost/~/ffsend$ffsendupload--hosthttp://localhost/./dir~/ffsend$ffsendupload--hosthttp://localhost/./dir--copy~/ffsend$ffsendupload--hosthttp://localhost/./dir--copy--password~/ffsend$ffsendupload--hosthttp://localhost/./dir--copy--password--downloads~/ffsend$ffsendupload--hosthttp://localhost/./dir--copy--password--downloads10You'veselectedadirectory,onlyasinglefilemaybeuploaded.Archivethedirectoryintoasinglefile?[Y/n]:yArchiving...Password:Uploadcompleted589.02KB/589.02KB[=======================================]100.00%10.18MB/sSharelink:http://localhost/download/8c676a0415/#ppyvURZnNKxAXP503zx4ow~/ffsend$rm~/ffsend$rm-r~/ffsend$rm-rdir0directories,1file~/ffsend$ffsenddownloadhttp://localhost/download/8c676a0415/#ppyvURZnNKxAXP503zx4owThisfileisprotectedwithapassword.You'redownloadinganarchive,extractitintotheselecteddirectory?[Y/n]:yDownloadcompletet589.02KB/589.02KB[====================================]100.00%105.05MB/sExtracting...~/ffsend$ffsendin~/ffsend$ffsendinfo~/ffsend$ffsendinfohttp://localhost/download/8c676a0415/#ppyvURZnNKxAXP503zx4owID:8c676a0415Name:dir.tarSize:589.02KiB(603152B)MIME:application/x-tarDownloads:1of10Expiry:23h59m(86369s)~/ffsend$ffsendhistory#LINKEXPIRYOWNERTOKEN1http://localhost/download/8c676a0415/#ppyvURZnNKxAXP503zx4ow23h59m4cfe63017d9eade8a9552http://send.firefox.com/download/eb2ab818cc/#F8_WgM3tz1t05yiPMsBgIw23h58m084577d86526aa999dc6~/ffsend$ffsenduploadi~/ffsend$ffsenduploadim~/ffsend$ffsenduploadima~/ffsend$ffsenduploadimag~/ffsend$ffsenduploadimage~/ffsend$ffsenduploadimage.~/ffsend$ffsenduploadimage.p~/ffsend$ffsenduploadimage.pn~/ffsend$ffsenduploadimage.png-~/ffsend$ffsenduploadimage.png--~/ffsend$ffsenduploadimage.png--c~/ffsend$ffsenduploadimage.png--co~/ffsend$ffsenduploadimage.png--copEncrypt&Upload7.88KB/116.93KB[==>-------------------------------------]6.74%164.29MB/s0sOverwrite?[y/n]:Download&Decrypt7.49KB/116.93KB[==>------------------------------------]6.41%45.45MB/s0s~/ffsend$ffsendupload-~/ffsend$ffsendupload--~/ffsend$ffsendupload--h~/ffsend$ffsendupload--ho~/ffsend$ffsendupload--hos~/ffsend$ffsendupload--hosth~/ffsend$ffsendupload--hostht~/ffsend$ffsendupload--hosthtt~/ffsend$ffsendupload--hosthttp~/ffsend$ffsendupload--hosthttp:~/ffsend$ffsendupload--hosthttp:/~/ffsend$ffsendupload--hosthttp://~/ffsend$ffsendupload--hosthttp://l~/ffsend$ffsendupload--hosthttp://lo~/ffsend$ffsendupload--hosthttp://loc~/ffsend$ffsendupload--hosthttp://loca~/ffsend$ffsendupload--hosthttp://local~/ffsend$ffsendupload--hosthttp://localh~/ffsend$ffsendupload--hosthttp://localho~/ffsend$ffsendupload--hosthttp://localhos~/ffsend$ffsendupload--hosthttp://localhost~/ffsend$ffsendupload--hosthttp://localhost/.~/ffsend$ffsendupload--hosthttp://localhost/./~/ffsend$ffsendupload--hosthttp://localhost/./d~/ffsend$ffsendupload--hosthttp://localhost/./di~/ffsend$ffsendupload--hosthttp://localhost/./dir-~/ffsend$ffsendupload--hosthttp://localhost/./dir--~/ffsend$ffsendupload--hosthttp://localhost/./dir--c~/ffsend$ffsendupload--hosthttp://localhost/./dir--co~/ffsend$ffsendupload--hosthttp://localhost/./dir--cop~/ffsend$ffsendupload--hosthttp://localhost/./dir--copy-~/ffsend$ffsendupload--hosthttp://localhost/./dir--copy--~/ffsend$ffsendupload--hosthttp://localhost/./dir--copy--p~/ffsend$ffsendupload--hosthttp://localhost/./dir--copy--pa~/ffsend$ffsendupload--hosthttp://localhost/./dir--copy--pas~/ffsend$ffsendupload--hosthttp://localhost/./dir--copy--pass~/ffsend$ffsendupload--hosthttp://localhost/./dir--copy--passw~/ffsend$ffsendupload--hosthttp://localhost/./dir--copy--passwo~/ffsend$ffsendupload--hosthttp://localhost/./dir--copy--passwor~/ffsend$ffsendupload--hosthttp://localhost/./dir--copy--password-~/ffsend$ffsendupload--hosthttp://localhost/./dir--copy--password--~/ffsend$ffsendupload--hosthttp://localhost/./dir--copy--password--d~/ffsend$ffsendupload--hosthttp://localhost/./dir--copy--password--do~/ffsend$ffsendupload--hosthttp://localhost/./dir--copy--password--dow~/ffsend$ffsendupload--hosthttp://localhost/./dir--copy--password--down~/ffsend$ffsendupload--hosthttp://localhost/./dir--copy--password--downl~/ffsend$ffsendupload--hosthttp://localhost/./dir--copy--password--downlo~/ffsend$ffsendupload--hosthttp://localhost/./dir--copy--password--downloa~/ffsend$ffsendupload--hosthttp://localhost/./dir--copy--password--download~/ffsend$ffsendupload--hosthttp://localhost/./dir--copy--password--downloads1Archivethedirectoryintoasinglefile?[Y/n]:Encrypt&Upload7.88KB/589.02KB[>----------------------------------------]1.34%73.23MB/s0sEncrypt&Upload589.02KB/589.02KB[=======================================]100.00%10.18MB/s~/ffsend$r~/ffsend$rm-~/ffsend$rm-rd~/ffsend$rm-rdiYou'redownloadinganarchive,extractitintotheselecteddirectory?[Y/n]:Download&Decrypt7.49KB/589.02KB[>--------------------------------------]1.27%33.97MB/s0s~/ffsend$ffsendi~/ffsend$ffsendinf~/ffsend$ffsendinf~/ffsend$ffsendh~/ffsend$ffsendhi~/ffsend$ffsendhis~/ffsend$ffsendhist~/ffsend$ffsendhisto~/ffsend$ffsendhistor \ No newline at end of file diff --git a/res/ffsend-demo.gif b/res/ffsend-demo.gif deleted file mode 100644 index 0de2f89..0000000 Binary files a/res/ffsend-demo.gif and /dev/null differ diff --git a/res/ffsend-demo.mp4 b/res/ffsend-demo.mp4 deleted file mode 100644 index 7017139..0000000 Binary files a/res/ffsend-demo.mp4 and /dev/null differ