\n\n# NEST SFTP\n\nThis is nest-sftp.\n\n## Description\n\n[Nest](https://github.com/nestjs/nest) framework module wrapper around [ssh2-sftp-client](https://github.com/jyu213/ssh2-sftp-client)\n\n## Installation\n\n```bash\n$ npm install --save nest-sftp\n```\n\n## Register in AppModule\n\nRegister the SftpModule in you App Module.\n\nThis version uses forRootAsync\n\n```typescript\nimport { SftpModule } from 'nest-sftp';\n\n@Module({\n imports: [\n SftpModule.forRootAsync(\n {\n useFactory: (configService: ConfigService) => {\n return configService.getSftpConnectionInfo();\n },\n inject: [ConfigService],\n imports: [AppModule],\n },\n false,\n ),\n ],\n controllers: [],\n providers: [ConfigService],\n exports: [ConfigService],\n})\nexport class AppModule {}\n```\n\nThe Options object implements the ConnectConfig from ssh2.\n\n```typescript\nimport { SftpModule } from 'nest-sftp';\n\n@Module({\n imports: [\n SftpModule.forRoot(\n {\n host: 'fakehost.com',\n port: 22,\n username: 'fakeUser',\n password: '*****', // passwords should not contain \\ (thy should be espaced like \\\\) and they cannot contain ! or (\n },\n false,\n ),\n ],\n controllers: [],\n providers: [],\n})\nexport class AppModule {}\n```\n\nWith debug logging:\n\n```typescript\nimport { SftpModule } from 'nest-sftp';\n\n@Module({\n imports: [\n SftpModule.forRoot(\n {\n host: 'fakehost.com',\n port: 22,\n username: 'fakeUser',\n password: '*****', // passwords should not contain \\ (thy should be espaced like \\\\) and they cannot contain ! or (\n debug: console.log, // adds logging for researching problems\n },\n false,\n ),\n ],\n controllers: [],\n providers: [],\n})\nexport class AppModule {}\n```\n\n## Dependency Inject Service\n\nThe SftpModule is global. The forRoot() method will open the connection as well during AppModule registration.\nThen the SftpClientService can be injected into your class.\n\n```typescript\nimport { SftpClientService } from 'nest-sftp';\n\nexport class AppService {\n private readonly logger: Logger;\n constructor(private readonly sftpClient: SftpClientService) {\n logger = new Logger();\n }\n\n async download(\n remotePath: string,\n localPath: string,\n ): Promise {\n return await this.sftpClient.download(remotePath, localPath);\n }\n // change connection to a different user/password prior to upload\n async submit(\n remotePath: string,\n localPath: string,\n submitConfig: ConnectConfig,\n ): Promise {\n await this.sftpClient.resetConnection(submitConfig);\n return await this.sftpClient.upload(remotePath, localPath);\n }\n}\n```\n\n## Support\n\nNest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).\n\n## Stay in touch\n\n- Author - [Benjamin Main](mailto::bmain@lumeris.com)\n- Author - [Victor Frank](mailto::vfrank@lumeris.com)\n\n## License\n\nNest SFTP is [MIT licensed](LICENSE).\n","readmeFilename":"README.md"}
![](\"https://blogs.mulesoft.com/wp-content/uploads/2017/11/sftp-ftp-mulesoft-connector-anypoint.png\")