beavailable / share

Share something.

share

This is a command-line file sharing tool, which has just a single file and is easy to use.

Features

• Crossing multiple platforms
• Sharing directories, files and texts
• Receiving files and texts
• Range request support
• Password sharing
• TLS support
• Zstd compression support (requires python-zstandard library, but is optional)

Usage

usage: share.py [-b ADDRESS] [-p PORT] [-s] [-r] [-a] [-t] [-P [PASSWORD]] [-h] [--certfile CERTFILE] [--keyfile KEYFILE] [--keypass KEYPASS] [arguments ...]

positional arguments:
  arguments             a directory, files or texts

general options:
  -b ADDRESS, --bind ADDRESS
                        bind address [default: all interfaces]
  -p PORT, --port PORT  port [default: 8888]
  -s, --share           share mode (default mode)
  -r, --receive         receive mode, can be used with -s option (only for directory)
  -a, --all             show all files, including hidden ones, only for directory
  -t, --text            for text
  -P [PASSWORD], --password [PASSWORD]
                        access password, if no PASSWORD is specified, the environment variable SHARE_PASSWORD will be used
  -h, --help            show this help message and exit

tls options:
  --certfile CERTFILE   cert file
  --keyfile KEYFILE     key file
  --keypass KEYPASS     key password

Screenshot

Tips

• If you're sharing just one file, you can use the shortcut name file to access it：

  http://{host}:{port}/file

  To save with the original filename with wget:

  wget --content-disposition http://{host}:{port}/file

  Or with curl:

  curl -OJ http://{host}:{port}/file

• To download an archive of a folder or a compressed file, you can add one of the following extensions to the url:
  • .tar for the folder, without compression
  • .tzst or .tar.zst for the folder, with compression (requires python-zstandard library)
  • .zst for the file (requires python-zstandard library)
• If you want to upload files to the sharing server with curl, you can use:

  curl -F file=@/path/to/file http://{host}:{port}
  # create new folders at the same time
  curl -F file=@/path/to/file http://{host}:{port}/custom/path

  Or:

  curl -T /path/to/file http://{host}:{port}
  # create new folders at the same time
  curl -T /path/to/file http://{host}:{port}/custom/path/
  # with a different filename
  curl -T /path/to/file http://{host}:{port}/custom/path/custom-filename