{"id":21611301,"url":"https://github.com/runnerty/executor-ftp","last_synced_at":"2025-07-04T18:07:42.511Z","repository":{"id":31866964,"uuid":"129390102","full_name":"runnerty/executor-ftp","owner":"runnerty","description":"Runnerty module: FTP executor","archived":false,"fork":false,"pushed_at":"2022-11-10T04:31:22.000Z","size":91,"stargazers_count":1,"open_issues_count":5,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-25T07:02:42.675Z","etag":null,"topics":["executor","ftp","ftp-client","runnerty"],"latest_commit_sha":null,"homepage":null,"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/runnerty.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":"2018-04-13T10:59:41.000Z","updated_at":"2021-01-07T19:05:14.000Z","dependencies_parsed_at":"2023-01-14T19:56:10.431Z","dependency_job_id":null,"html_url":"https://github.com/runnerty/executor-ftp","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runnerty%2Fexecutor-ftp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runnerty%2Fexecutor-ftp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runnerty%2Fexecutor-ftp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runnerty%2Fexecutor-ftp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/runnerty","download_url":"https://codeload.github.com/runnerty/executor-ftp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244166707,"owners_count":20409178,"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":["executor","ftp","ftp-client","runnerty"],"created_at":"2024-11-24T21:11:54.040Z","updated_at":"2025-03-18T16:04:40.016Z","avatar_url":"https://github.com/runnerty.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"http://runnerty.io\"\u003e\n    \u003cimg height=\"257\" src=\"https://runnerty.io/assets/header/logo-stroked.png\"\u003e\n  \u003c/a\u003e\n  \u003cp align=\"center\"\u003eSmart Processes Management\u003c/p\u003e\n\u003c/p\u003e\n\n[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Dependency Status][david-badge]][david-badge-url] \n\u003ca href=\"#badge\"\u003e\n  \u003cimg alt=\"code style: prettier\" src=\"https://img.shields.io/badge/code_style-prettier-ff69b4.svg\"\u003e\n\u003c/a\u003e\n\n\n# FTP executor for [Runnerty]:\n\n### Installation:\n```bash\nnpm i @runnerty/executor-ftp\n```\n\n### Configuration sample:\n```json\n{\n  \"id\": \"ftp_default\",\n  \"type\": \"@runnerty-executor-ftp\",\n  \"host\": \"host.com\",\n  \"port\": \"21\",\n  \"user\": \"user\",\n  \"password\": \"1234\"\n}\n```\n\n```json\n{\n  \"id\": \"ftp_default\",\n  \"type\": \"@runnerty-executor-ftp\",\n  \"host\": \"host.com\",\n  \"port\": \"21\",\n  \"user\": \"user\",\n  \"privateKey\": \"/privateKeys/myPrivateKey.pem\"\n}\n```\n\n### Plan sample:\n```json\n{\n  \"id\": \"ftp_default\",\n  \"command\": \"PUT\",\n  \"sourcePath\": \"./sample.txt\",\n  \"destinationPath\": \"/remote/sample_file.txt\"\n}\n```\n\n```json\n{\n  \"id\": \"ftp_default\",\n  \"command\": \"LIST\",\n  \"sourcePath\": \"./remoteDir/\"\n}\n```\n\n### Connection:\nConnection config you will see [here](https://github.com/mscdex/ssh2#user-content-client-methods)\n\n### Commands\n* get: download a file.\n* put: upload a file.\n* mkdir: create a new directory.\n* rmdir: remove the directory or file.\n* delete: delete file.\n* rename: rename sourcePath to destinationPath.\n* chmod: modify rights to destinationPath file.\n* list: retrieves a directory listing.\n\n### Output (Process values):\n* `PROCESS_EXEC_DATA_OUTPUT`: Response output data.\n* `EXTRA_DATA`: It is possible to work with the parsed values of the response.\n\n`LIST` command return a JSON with this properties:\n```bash\ntype: // file type(-, d, l)\nname: // file name\nsize: // file size\nmodifyTime: // file timestamp of modified time\naccessTime: // file timestamp of access time\nrights: {\n    user:\n    group:\n    other:\n},\nowner: // user ID\ngroup: // group ID\n```\n\n\n\n[Runnerty]: http://www.runnerty.io\n[downloads-image]: https://img.shields.io/npm/dm/@runnerty/executor-ftp.svg\n[npm-url]: https://www.npmjs.com/package/@runnerty/executor-ftp\n[npm-image]: https://img.shields.io/npm/v/@runnerty/executor-ftp.svg\n[david-badge]: https://david-dm.org/runnerty/executor-ftp.svg\n[david-badge-url]: https://david-dm.org/runnerty/executor-ftp\n[config.json]: http://docs.runnerty.io/config/\n[plan.json]: http://docs.runnerty.io/plan/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frunnerty%2Fexecutor-ftp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frunnerty%2Fexecutor-ftp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frunnerty%2Fexecutor-ftp/lists"}