{"analyzedAt":"2022-06-28T19:26:30.131Z","collected":{"metadata":{"name":"scp-promises","scope":"unscoped","version":"0.5.0","description":"Asynchronous scp up- and download","keywords":["scp","async","ssh"],"date":"2021-04-10T11:07:36.162Z","author":{"name":"Manfred Michaelis"},"publisher":{"username":"jibbex","email":"mm@michm.de"},"maintainers":[{"username":"jibbex","email":"mm@michm.de"}],"repository":{"type":"git","url":"git+https://github.com/jibbex/scp-promises.git","directory":"jibbex/scp-promises"},"links":{"npm":"https://www.npmjs.com/package/scp-promises","homepage":"https://michm.de","repository":"https://github.com/jibbex/scp-promises","bugs":"https://github.com/jibbex/scp-promises/issues"},"license":"MIT","releases":[{"from":"2022-05-29T00:00:00.000Z","to":"2022-06-28T00:00:00.000Z","count":0},{"from":"2022-03-30T00:00:00.000Z","to":"2022-06-28T00:00:00.000Z","count":1},{"from":"2021-12-30T00:00:00.000Z","to":"2022-06-28T00:00:00.000Z","count":1},{"from":"2021-06-28T00:00:00.000Z","to":"2022-06-28T00:00:00.000Z","count":1},{"from":"2020-06-28T00:00:00.000Z","to":"2022-06-28T00:00:00.000Z","count":7}],"hasTestScript":true,"readme":"# scp-promises\r\n\r\nA Node.js module for asynchronous scp uploads and downloads. Inspired by [node-scp](https://github.com/ecto/node-scp), which is apparently no longer maintained.\r\n\r\n## About\r\n\r\n``CreateScpConnection`` returns an instance of ``Scp``. The ``Scp`` object has ``get`` and ``send`` methods which return promises. If no password is passed to the options object during initialization, the password prompt is piped to the console.\r\n\r\n## Getting Started\r\n> Run simply npm install or yarn add to install *scp-promises*\r\n\r\n\r\n```\r\n$ npm i scp-promises --save\r\n```\r\n\r\n***OR***\r\n\r\n```\r\n$ yarn add scp-promises\r\n```\r\n\r\n```javascript\r\nimport { CreateScpConnection }  from 'scp-promises'\r\n\r\n(async () => {\r\n    try {\r\n        const scp = CreateScpConnection({host: 'michm.de', user: 'jibblez'});\r\n\r\n        await scp.send({path: '/home/jibblez/TESTFILE.dat', file: './README.md'});\r\n        await scp.get({path: '/home/jibblez/TESTFILE.dat', file: './1233213.md'})\r\n    }\r\n    catch(error) {\r\n        console.error(error);\r\n    }\r\n})();\r\n```\r\n\r\n## ``Class Scp``\r\n\r\n> CreateScpConnection(options : @Object{})\r\n> \r\n|property          | description                                                             |\r\n|------------------|---------------------------------------------------------------------------|\r\n| **host**     | URL or IP Address of the host                             |\r\n| **user**         | Login Username                                                      |\r\n| *password*  | Only neccessary if needed for login              |\r\n| port             | *22* is default                                                  | \r\n\r\n> send(options : @Object{})\r\n> \r\n|property          | description                                                               |\r\n|------------------|---------------------------------------------------------------------------|\r\n| **path**     | The path to the remote file                            |\r\n| **file**         | The local file                                                      |\r\n\r\n> get(options : @Object{})\r\n> \r\n|property          | description                                                               |\r\n|------------------|---------------------------------------------------------------------------|\r\n| **path**     | The path to the remote file                            |\r\n| **file**         | The local file                                                      |\r\n\r\n\r\n***Fat*** *properties are required.*"},"npm":{"downloads":[{"from":"2022-06-27T00:00:00.000Z","to":"2022-06-28T00:00:00.000Z","count":4},{"from":"2022-06-21T00:00:00.000Z","to":"2022-06-28T00:00:00.000Z","count":26},{"from":"2022-05-29T00:00:00.000Z","to":"2022-06-28T00:00:00.000Z","count":88},{"from":"2022-03-30T00:00:00.000Z","to":"2022-06-28T00:00:00.000Z","count":188},{"from":"2021-12-30T00:00:00.000Z","to":"2022-06-28T00:00:00.000Z","count":345},{"from":"2021-06-28T00:00:00.000Z","to":"2022-06-28T00:00:00.000Z","count":632}],"starsCount":0},"github":{"homepage":"https://www.npmjs.com/package/scp-promises","starsCount":1,"forksCount":0,"subscribersCount":2,"issues":{"count":0,"openCount":0,"distribution":{"3600":0,"10800":0,"32400":0,"97200":0,"291600":0,"874800":0,"2624400":0,"7873200":0,"23619600":0,"70858800":0,"212576400":0},"isDisabled":false},"contributors":[{"username":"jibbex","commitsCount":11}],"commits":[{"from":"2022-06-21T00:00:00.000Z","to":"2022-06-28T00:00:00.000Z","count":0},{"from":"2022-05-29T00:00:00.000Z","to":"2022-06-28T00:00:00.000Z","count":0},{"from":"2022-03-30T00:00:00.000Z","to":"2022-06-28T00:00:00.000Z","count":0},{"from":"2021-12-30T00:00:00.000Z","to":"2022-06-28T00:00:00.000Z","count":0},{"from":"2021-06-28T00:00:00.000Z","to":"2022-06-28T00:00:00.000Z","count":0}]},"source":{"files":{"readmeSize":2407,"testsSize":459}}},"evaluation":{"quality":{"carefulness":0.355,"tests":0.6,"health":1,"branding":0.4},"popularity":{"communityInterest":4,"downloadsCount":62.666666666666664,"downloadsAcceleration":0.3467465753424657,"dependentsCount":0},"maintenance":{"releasesFrequency":0.3606164383561644,"commitsFrequency":0,"openIssues":0.7,"issuesDistribution":0.7}},"score":{"final":0.5436834573198412,"detail":{"quality":0.8074604441279951,"popularity":0.03099213299350291,"maintenance":0.830280221524905}}}