1.0.4 • Published 4 years ago

fichier v1.0.4

Weekly downloads
5
License
ISC
Repository
github
Last release
4 years ago

alt text

Fichier

Share files from your computer with other devices even around the world with ease.

Highlights

  • Serve your files or folders with anyone in the world
  • QR Generated for every shared file or folder
  • Clean and impressive

Installation

Visit the API Documentation for a list of all methods available.

$ npm install fichier -g

Usage

We recomend using a task manager like Elk from our partner @jjzcru for running the server along with NGROK to allow people to access to the files from outside our LAN.

fichier --{command} [options]

Available Commands

  • start: Start sharing server from a task manager.
  • share: Share files or folders from your computer.
  • config: Setup your sharing configuration.
  • list: Show your currently sharing files or folders.
  • display: Generate QR for an already shared file or folder.
  • clear: Clear your sharing list.
  • remove: Delete a file or folder from sharing.
  • help: Show CLI help.

Examples

List al shared files or folders.

fichier --list

Change your access url to the files.

by default the tool is set to run on localhost:3000

fichier -c url url_to_access

change the running port for server.

by default the tool is set to run on 3000 note: this should match the port on the url.

fichier -c port running_port

Share a folder located in /desktop/images

fichier --share /folder_path/desktop/images

or

fichier -s
then follow the instructions.

Examples

Clear al shared files or folders

fichier --clear

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

no licenses defined yet.