Introduction

SSH and SFTP client library for React Native on iOS and Android.

A powerful SSH and SFTP client library for React Native applications, providing seamless connectivity to remote servers on both iOS and Android platforms.

On iOS, this package currently doesn’t support the simulator. You will need to run your app on a physical device. See this issue for more details.

Key Features

Multiple Authentication Methods

Support for both password-based and public key authentication with optional passphrase protection.

SSH Command Execution

Execute remote commands and receive output with fully promise-based API.

Interactive Shell Sessions

Start and manage interactive shell sessions with support for multiple PTY types.

Full SFTP Support

Complete file transfer capabilities including upload, download, directory operations, and progress tracking.

Cross-Platform

Works on both iOS and Android with a unified API.

TypeScript Support

Fully typed API with comprehensive interfaces and type definitions.

What You Can Build

With this library, you can build React Native applications that:

• Execute remote commands on SSH servers
• Transfer files securely using SFTP
• Manage remote file systems (create, delete, rename files and directories)
• Monitor file transfer progress in real-time
• Maintain interactive shell sessions
• Connect using password or key-based authentication

Getting Started

Installation

Install the library and configure your project for iOS and Android.

Quick Start

Get up and running with a simple example in minutes.

API Reference

Explore the complete API documentation.

Requirements

• React Native 0.60 or later (supports autolinking)
• Node.js 18.16.0 or later
• npm 9.5.0 or later
• iOS physical device (the simulator is not supported at this time)
• Android: No additional requirements