react-native-ssh

KO | EN

gitlite — search

#javascript #python #ai #typescript #android #machine-learning #rust #linux #docker #macos #awesome #awesome-list #vue #mcp

react-native-ssh

(★ 74)

a library that enables React Native apps to execute commands over SSH -

react-native-ssh Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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`

react-native-ssh

react-native-ssh Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

react-native-ssh

react-native-ssh Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README