Skip to content

Latest commit

 

History

History
113 lines (75 loc) · 3.29 KB

README.md

File metadata and controls

113 lines (75 loc) · 3.29 KB

Directory Serve

Directory Serve - Open source CLI to send and receive file | Product Hunt

Directory serve is a CLI library for sending and receiving a file from your android and IOS devices.

Installation

This is a Node.js module available through the npm registry. Installation is done using the npm install command:

$ npm install -g directory-serve

Help

npx directory-serve --help

Usage

After installing globally

 directory-serve /path-of-directory

or

Directly use the command

 npx directory-serve /path-of-directory

or

npx directory-serve /path-to-file

Arguments

options default description Example
u true Restrict upload file option npx directory-serve /path-of-directory -u=false
p 8989 Change the port npx directory-serve /path-of-directory -p=3000
help Help npx directory-serve --help
username undefined Client auth username npx directory-serve /path-of-directory --username=my_username
password undefined Client auth password (optional) npx directory-serve /path-of-directory --username=my_username --password=my_password
delete false To delete file/folder npx directory-serve /path-of-directory --delete=true
debug false Debug mode npx directory-serve /path-of-directory --delete=true --debug=true

Examples

npx directory-serve .
npx directory-serve ~/Desktop
npx directory-serve ~/Desktop/my_image.png
npx directory-serve ~/Desktop -p=3000 --username=test --password=password

For Developing

prerequisite

  1. Node (>=12.0)

clone the repo and follow the commands
git clone https://github.com/cube-root/directory-serve.git
npm i
npm run dev /path-of-directory

For Contributing

Contribution Guide

Screenshot

CLI

screenshot

Client

screenshot screenshot

Client Auth

screenshot