SSH2 开源项目使用教程

1. 项目的目录结构及介绍

ssh2/
├── examples/
│   ├── async_connect.js
│   ├── exec.js
│   ├── forwardOut.js
│   ├── forwardIn.js
│   ├── sftp.js
│   ├── shell.js
│   ├── subsystem.js
│   └── tunnel.js
├── lib/
│   ├── client.js
│   ├── http.js
│   ├── index.js
│   ├── sftp.js
│   ├── stream.js
│   ├── utils.js
│   └── version.js
├── node_modules/
├── test/
│   ├── client.js
│   ├── http.js
│   ├── sftp.js
│   ├── stream.js
│   └── utils.js
├── .gitignore
├── .npmignore
├── .travis.yml
├── LICENSE
├── README.md
├── appveyor.yml
├── package.json
└── binding.gyp

• examples/: 包含多个示例文件，展示了如何使用 ssh2 模块进行各种操作，如连接、执行命令、文件传输等。
• lib/: 包含项目的主要代码文件，包括客户端、HTTP、SFTP 等模块。
• node_modules/: 存放项目依赖的第三方模块。
• test/: 包含项目的测试文件，用于确保代码的正确性。
• .gitignore: 指定 Git 版本控制系统忽略的文件和目录。
• .npmignore: 指定 npm 发布时忽略的文件和目录。
• .travis.yml: Travis CI 的配置文件。
• LICENSE: 项目的许可证。
• README.md: 项目的说明文档。
• appveyor.yml: AppVeyor CI 的配置文件。
• package.json: 项目的配置文件，包含依赖、脚本等信息。
• binding.gyp: 用于编译本地模块的配置文件。

2. 项目的启动文件介绍

项目的启动文件通常是 examples/ 目录下的示例文件。例如，examples/exec.js 展示了如何连接到 SSH 服务器并执行命令。

const { Client } = require('ssh2');

const conn = new Client();
conn.on('ready', () => {
  console.log('Client :: ready');
  conn.exec('uptime', (err, stream) => {
    if (err) throw err;
    stream.on('close', (code, signal) => {
      console.log('Stream :: close :: code: ' + code + ', signal: ' + signal);
      conn.end();
    }).on('data', (data) => {
      console.log('STDOUT: ' + data);
    }).stderr.on('data', (data) => {
      console.log('STDERR: ' + data);
    });
  });
}).connect({
  host: '192.168.100.100',
  port: 22,
  username: 'frylock',
  password: 'nodejsrules'
});

3. 项目的配置文件介绍

项目的配置文件主要是 package.json，它包含了项目的元数据和依赖信息。

{
  "name": "ssh2",
  "version": "1.1.0",
  "description": "SSH2 client and server modules written in pure JavaScript for node.js",
  "main": "lib/index.js",
  "scripts": {
    "test": "node test/test.js"
  },
  "dependencies": {
    "readable-stream": "^3.6.0"
  },
  "devDependencies": {
    "eslint": "^7.20.0",
    "eslint-config-standard": "^16.0.2",
    "eslint-plugin-import": "^2.22.1",
    "eslint-plugin-node": "^11.1.0",
    "eslint-plugin-promise": "^4.3.1"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/mscdex/ssh2.git"
  },
  "keywords": [
    "ssh",
    "ssh2",
    "sftp