# ssh-remote-port-forward

> SSH remote port forward

Latest version **1.0.4** (published 2021-09-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install ssh-remote-port-forward
pnpm add ssh-remote-port-forward
yarn add ssh-remote-port-forward
bun add ssh-remote-port-forward
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2021-09-23 |
| First published | 2020-11-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 7.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Cristian Greco |
| Maintainers | cristianrgreco |
| Keywords | ssh, remote, port, forward, forwarding |

## Links

- npm: https://www.npmjs.com/package/ssh-remote-port-forward
- Repository: https://github.com/cristianrgreco/ssh-remote-port-forward
- Homepage: https://github.com/cristianrgreco/ssh-remote-port-forward#readme
- Issues: https://github.com/cristianrgreco/ssh-remote-port-forward/issues
- npm.io page: https://npm.io/package/ssh-remote-port-forward

## Dependencies (2)

- [ssh2](https://npm.io/package/ssh2.md) ^1.4.0
- [@types/ssh2](https://npm.io/package/@types/ssh2.md) ^0.5.48

## Alternatives

- [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads
- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads

## Recent versions

- 1.0.4 (latest) — 2021-09-23
- 1.0.3 — 2020-11-09
- 1.0.2 — 2020-11-09
- 1.0.1 — 2020-11-09

## README

# SSH Remote Port Forward

> Allows the client to tunnel back to the host.

![Node.js CI](https://github.com/cristianrgreco/ssh-remote-port-forward/workflows/Node.js%20CI/badge.svg?branch=main)
[![npm version](https://badge.fury.io/js/ssh-remote-port-forward.svg)](https://www.npmjs.com/package/ssh-remote-port-forward)
[![npm version](https://img.shields.io/npm/dm/ssh-remote-port-forward.svg)](https://www.npmjs.com/package/ssh-remote-port-forward)

## Install

```bash
npm install --save ssh-remote-port-forward
```

## Usage

```typescript
import { 
  createSshConnection, 
  SshConnection, 
  ConnectConfig 
} from "ssh-remote-port-forward";

const connectConfig: ConnectConfig = {
  host: "example",
  port: "22",
};

const sshConnection: SshConnection = await createSshConnection(
  connectConfig
);

await sshConnection.remoteForward("localhost", 8000)
```

---
_Source: https://npm.io/package/ssh-remote-port-forward · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._