Mastering the commands - eze-kiel/shaloc GitHub Wiki

In shaloc, there is 8 commands available, but not all have the same importance.

Important commands

There is two important commands:

  • share: This one allows you to share a file or a folder. Its minimal usage is:
$ shaloc share -f file.txt

for a file, or:

$ shaloc share -F folder/

for a folder.

  • get: This command allows you to download a file from an URL. Its minimal usage is the following:
$ shaloc get -u http://ipAddr:port/file-to-get.ext

Of course, it behaves as wget or curl, or even a browser. Feel free to use anything else :)

Not so important commands

The is few commands that are not very important.

  • clean: This commands wipes all the garbage created by shaloc in your temporary files default folder.

  • completion: This command generates shell completion. Its usage is:

$ shaloc completion {bash,zsh,fish,powershell}
  • decrypt: This one can be useful. When you share a file/folder using AES, the client has to specify the flag --aes too in order to decrypt the data at the reception. If he forgot, he can still uncipher the data with this command. Its utilization is simple:
$ shaloc decrypt file-to-decrypt.ext

  • update: This command allow you to update shaloc. To do so, you have some sub commands:

    • list to list the versions available

    • latest to update to the latest version

    • v1.1.0 (for example, you can specify whatever version you want that is available).

  • version: You can see the current version of your shaloc, as well as the build date.

  • help: This one displays... help.