{"id":13604955,"url":"https://github.com/cube-root/directory-serve","last_synced_at":"2025-04-12T02:32:23.835Z","repository":{"id":61191877,"uuid":"549109453","full_name":"cube-root/directory-serve","owner":"cube-root","description":"CLI tool to send and receive file on a network to a server","archived":false,"fork":false,"pushed_at":"2022-11-27T16:08:16.000Z","size":758,"stargazers_count":429,"open_issues_count":5,"forks_count":16,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-09-19T18:37:35.075Z","etag":null,"topics":["cli","directory","filesystem","nodejs","send","server","static"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cube-root.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-10-10T17:31:10.000Z","updated_at":"2024-09-17T07:12:03.000Z","dependencies_parsed_at":"2022-10-12T12:10:15.781Z","dependency_job_id":null,"html_url":"https://github.com/cube-root/directory-serve","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cube-root%2Fdirectory-serve","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cube-root%2Fdirectory-serve/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cube-root%2Fdirectory-serve/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cube-root%2Fdirectory-serve/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cube-root","download_url":"https://codeload.github.com/cube-root/directory-serve/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223489709,"owners_count":17153809,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","directory","filesystem","nodejs","send","server","static"],"created_at":"2024-08-01T19:00:53.044Z","updated_at":"2024-11-07T09:31:19.299Z","avatar_url":"https://github.com/cube-root.png","language":"JavaScript","readme":"# Directory Serve\n\n\u003ca href=\"https://www.producthunt.com/posts/directory-serve?utm_source=badge-featured\u0026utm_medium=badge\u0026utm_souce=badge-directory\u0026#0045;serve\" target=\"_blank\"\u003e\u003cimg src=\"https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=365677\u0026theme=light\" alt=\"Directory\u0026#0032;Serve - Open\u0026#0032;source\u0026#0032;CLI\u0026#0032;to\u0026#0032;send\u0026#0032;and\u0026#0032;receive\u0026#0032;file | Product Hunt\" style=\"width: 250px; height: 54px;\" width=\"250\" height=\"54\" /\u003e\u003c/a\u003e\n\nDirectory serve is a CLI library for sending and receiving a file from your android and IOS devices.\n\n## Installation\n\nThis is a [Node.js](https://nodejs.org/en/) module available through the\n[npm registry](https://www.npmjs.com/). Installation is done using the\n[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):\n\n```bash\n$ npm install -g directory-serve\n```\n\n## Help\n\n```bash\nnpx directory-serve --help\n```\n\n## Usage\n\nAfter installing globally\n\n```bash\n directory-serve /path-of-directory\n```\n\nor\n\nDirectly use the command\n\n```bash\n npx directory-serve /path-of-directory\n```\n\nor\n\n```bash\nnpx directory-serve /path-to-file\n```\n\n## Arguments\n\n| options  |  default  |           description           |                                         Example                                         |\n| :------: | :-------: | :-----------------------------: | :-------------------------------------------------------------------------------------: |\n|    u     |   true    |   Restrict upload file option   |                    `npx directory-serve /path-of-directory -u=false`                    |\n|    p     |   8989    |         Change the port         |                    `npx directory-serve /path-of-directory -p=3000`                     |\n|   help   |           |              Help               |                              `npx directory-serve --help `                              |\n| username | undefined |      Client auth username       |            `npx directory-serve /path-of-directory --username=my_username `             |\n| password | undefined | Client auth password (optional) | `npx directory-serve /path-of-directory --username=my_username --password=my_password ` |\n|  delete  |   false   |      To delete file/folder      |                 `npx directory-serve /path-of-directory --delete=true`                  |\n|  debug   |   false   |           Debug mode            |           `npx directory-serve /path-of-directory --delete=true --debug=true`           |\n\n## Examples\n\n```bash\nnpx directory-serve .\n```\n\n```bash\nnpx directory-serve ~/Desktop\n```\n\n```bash\nnpx directory-serve ~/Desktop/my_image.png\n```\n\n```bash\nnpx directory-serve ~/Desktop -p=3000 --username=test --password=password\n```\n\n## For Developing\n\n### prerequisite\n\n1. Node (\u003e=12.0)\n\n\u003cbr/\u003e\nclone the repo and follow the commands\n\n```bash\ngit clone https://github.com/cube-root/directory-serve.git\n```\n\n```bash\nnpm i\n```\n\n```bash\nnpm run dev /path-of-directory\n```\n\n## For Contributing\n\n[Contribution Guide](/docs/CONTRIBUTING.MD)\n\n## Screenshot\n\n### CLI\n\n![screenshot](/docs/screenshots/terminal-screenshot.png?raw=true \"Directory serve\")\n\n### Client\n\n![screenshot](/docs/screenshots/directory-list.png?raw=true)\n![screenshot](/docs/screenshots/browser_with_remove.png?raw=true)\n\n### Client Auth\n\n![screenshot](/docs/screenshots/basic-auth.png?raw=true)\n","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcube-root%2Fdirectory-serve","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcube-root%2Fdirectory-serve","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcube-root%2Fdirectory-serve/lists"}