{"id":16760275,"url":"https://github.com/roccomuso/transfer-sh","last_synced_at":"2025-07-05T17:04:43.775Z","repository":{"id":17961460,"uuid":"83088899","full_name":"roccomuso/transfer-sh","owner":"roccomuso","description":"Node.js CLI tool for easy file sharing using Transfer.sh","archived":false,"fork":false,"pushed_at":"2022-06-22T13:44:02.000Z","size":156,"stargazers_count":25,"open_issues_count":6,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-06-28T18:08:44.234Z","etag":null,"topics":["cli","file","file-sharing","nodejs","sharing","tool","transfer"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/roccomuso.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-02-24T22:39:54.000Z","updated_at":"2025-06-25T16:12:51.000Z","dependencies_parsed_at":"2022-09-05T08:10:50.745Z","dependency_job_id":null,"html_url":"https://github.com/roccomuso/transfer-sh","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/roccomuso/transfer-sh","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roccomuso%2Ftransfer-sh","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roccomuso%2Ftransfer-sh/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roccomuso%2Ftransfer-sh/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roccomuso%2Ftransfer-sh/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/roccomuso","download_url":"https://codeload.github.com/roccomuso/transfer-sh/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roccomuso%2Ftransfer-sh/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262667219,"owners_count":23345518,"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","file","file-sharing","nodejs","sharing","tool","transfer"],"created_at":"2024-10-13T04:22:57.448Z","updated_at":"2025-07-05T17:04:43.754Z","avatar_url":"https://github.com/roccomuso.png","language":"JavaScript","funding_links":["https://patreon.com/roccomuso"],"categories":[],"sub_categories":[],"readme":"# transfer-sh [![NPM Version](https://img.shields.io/npm/v/transfer-sh.svg)](https://www.npmjs.com/package/transfer-sh) [![Build Status](https://travis-ci.org/roccomuso/transfer-sh.svg?branch=master)](https://travis-ci.org/roccomuso/transfer-sh) [![Dependency Status](https://david-dm.org/roccomuso/transfer-sh.png)](https://david-dm.org/roccomuso/transfer-sh) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) \u003cspan class=\"badge-patreon\"\u003e\u003ca href=\"https://patreon.com/roccomuso\" title=\"Donate to this project using Patreon\"\u003e\u003cimg src=\"https://img.shields.io/badge/patreon-donate-yellow.svg\" alt=\"Patreon donate button\" /\u003e\u003c/a\u003e\u003c/span\u003e\n\n\u003e Node.js CLI tool for easy file sharing using Transfer.sh\n\n### Install\n\nThe easiest way to get **transfer-sh** is with npm:\n\n    $ npm install -g transfer-sh\n\n### CLI Usage\n\n    $ transfer hello.txt\n\nWill return a link to the resource and automatically you'll have it copied to your clipboard.\n\nPS. \u003ccode\u003etransfer\u003c/code\u003e is an alias for \u003ccode\u003etransfer-sh\u003c/code\u003e.\n\nEncrypt a file using a password:\n\n    $ transfer hello.txt -p s3cr3t\n\n### Example\n\n```javascript\nvar Transfer = require('transfer-sh')\n\n/* Encrypt and Upload */\nnew Transfer('./Hello.md', {password: 's3cr3t'})\n  .upload()\n  .then(function (link) { console.log(link) })\n  .catch(function (err) { console.log(err) })\n\n/* Decrypt */\nnew Transfer('./Hello.enc', {password: 's3cr3t'})\n  .decrypt('Output.md') // or writable stream\n  .then(function (wStream) { console.log('Decrypted!') }) // it returns a writableStream\n  .catch(function (err) { console.log(err) })\n\n```\n\n**NB.**: The constructor accepts also a `Readable` stream as 1th param, in that case make sure to provide a `name` option.\n\n### Options\n\n`password`: optional field, if provided will encrypt the file with `aes-256-cbc` no-salt and base64 encoded before the upload.\n\nYou can then easily decrypt your file using `transfer-sh` itself:\n\n    $ transfer -d hello.enc -p s3cr3t [-o output.txt]\n\nor the `openssl` util:\n\n    $ openssl aes-256-cbc -d -a -nosalt -in \u003cencrypted_file\u003e -out \u003cdestination\u003e -k \u003cpassword\u003e\n\nopenssl params explanation:\n\n`-d` decrypt.\n\n`-a` to decode base64 (with line break). NB. The file is base64 encoded to be easy human-readable and to allow easy copy-paste.\n\n`-nosalt` The used node crypto lib by default doesn't apply any salt.\n\n`-in` input encrypted file.\n\n`-out` output decrypted file.\n\n`-k` password.\n\n## Author\n\nRocco Musolino ([@roccomuso](https://twitter.com/roccomuso))\n\n## LICENSE\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froccomuso%2Ftransfer-sh","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Froccomuso%2Ftransfer-sh","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froccomuso%2Ftransfer-sh/lists"}