# react-native-ssh

**Repository Path**: mirrors_yorkie/react-native-ssh

## Basic Information

- **Project Name**: react-native-ssh
- **Description**: a library that enables React Native apps to execute commands over SSH -
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-11-23
- **Last Updated**: 2026-05-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# react-native-ssh [![npm version](https://badge.fury.io/js/react-native-ssh.svg)](https://badge.fury.io/js/react-native-ssh)

A library that allows a React Native app to run commands over SSH.

## Usage

This library provides a single method: `SSH.execute`. Given SSH credentials
and a command, a promise is returned. This promise resolves to the command's
output as an array of strings.

```javascript
import SSH from 'react-native-ssh';

config = {user: 'bob', host: 'example.com', password: 'p4$$w0rd'};
command = 'ls ~';

SSH.execute(config, command).then(
  result => console.log(result),
  error =>  console.log('Error:', error)
);

// A successful run would output:
// ['file1.txt', 'server.py', 'script.sh']
```

## Installation

### Android

- `npm install react-native-ssh --save`
- `react-native link react-native-ssh`

### iOS

- `npm install react-native-ssh --save`
- `react-native link react-native-ssh`
- Add `pod 'NMSSH', '~> 2.2.5'` to your Podfile and install. If you don't have a Podfile:
  - `cd ios`
  - `pod init`
  - Edit the newly created Podfile to look like [this example](Podfile.example)
  - `pod install`