# ssh2-socksv5-proxy

> ssh2 with client socksv5 proxy

Latest version **0.0.2** (published 2016-06-04) · ISC license · 0 weekly downloads

## Install

```sh
npm install ssh2-socksv5-proxy
pnpm add ssh2-socksv5-proxy
yarn add ssh2-socksv5-proxy
bun add ssh2-socksv5-proxy
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2016-06-04 |
| First published | 2016-06-04 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Paweł Łaski |
| Maintainers | zniwus |
| Keywords | ssh2, socksv5, proxy, tor, tor proxy |

## Links

- npm: https://www.npmjs.com/package/ssh2-socksv5-proxy
- Repository: https://github.com/rayros/ssh2-socksv5-proxy
- Homepage: https://github.com/rayros/ssh2-socksv5-proxy#readme
- Issues: https://github.com/rayros/ssh2-socksv5-proxy/issues
- npm.io page: https://npm.io/package/ssh2-socksv5-proxy

## Dependencies (2)

- [ssh2](https://npm.io/package/ssh2.md) ^0.5.0
- [socksv5](https://npm.io/package/socksv5.md) 0.0.6

## Alternatives

- [vest](https://npm.io/package/vest.md) — 50.1K weekly downloads
- [@regle/core](https://npm.io/package/@regle/core.md) — 47.0K weekly downloads
- [typeof-arguments](https://npm.io/package/typeof-arguments.md) — 12.5K weekly downloads
- [@lokalise/projects-engine-contracts](https://npm.io/package/@lokalise/projects-engine-contracts.md) — 978 weekly downloads
- [@osjwnpm/nam-laboriosam-quibusdam](https://npm.io/package/@osjwnpm/nam-laboriosam-quibusdam.md) — 70 weekly downloads

## Recent versions

- 0.0.2 (latest) — 2016-06-04
- 0.0.1 — 2016-06-04

## README

# ssh2 client with socksv5 proxy

## Usage
```js
const Client = require('ssh2-socksv5-proxy').Client;

const connection = new Client();
connection.connect({
  proxyHost: '<proxy host>',
  proxyPort: <proxy port>,
  ... options from ssh2
})
// all events from ssh2
connection.on('ready', function() {
  console.log('ready');
  connection.end();
});
connection.on('error', function(error) {
  console.log(error)
})
```

## Tor proxy
```js
const Client = require('ssh2-socksv5-proxy').Client;
const newClient = new Client();
newClient.connect({
  host: 'localhost',
  port: 22,
  proxyHost: '127.0.0.1',
  proxyPort: 9050,
  username: 'user',
  password: 'password'
})
newClient.on('ready', function() {
  console.log('ready');
  newClient.end();
});
newClient.on('error', function(error) {
  console.log(error)
})
```

---
_Source: https://npm.io/package/ssh2-socksv5-proxy · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._