Skip to content

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

Notifications You must be signed in to change notification settings

azlyth/react-native-ssh

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

react-native-ssh npm version

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.

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
    • pod install

About

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

Resources

Stars

Watchers

Forks

Packages

No packages published