NMSSH 技术文档

1. 安装指南

1.1 使用 CocoaPods 安装

在 Podfile 文件中添加以下内容：

pod 'NMSSH'

然后运行以下命令进行安装：

pod install

1.2 使用 Carthage 安装

在 Cartfile 文件中添加以下内容：

github "NMSSH/NMSSH"

然后运行以下命令进行安装：

carthage update

1.3 从源码构建

详细信息请参考项目的 Wiki 页面：

• 在 OSX 项目中构建和使用
• 在 iOS 项目中构建和使用

1.4 包含到项目中

在源文件中添加以下导入语句：

#import <NMSSH/NMSSH.h>

1.5 OpenSSL 和 Libssh2 二进制文件

NMSSH 包含预编译版本的 Libssh2 和 OpenSSL，这些库是通过 此脚本 编译的。你可以轻松重新编译这些库并替换二进制文件。

2. 项目使用说明

NMSSH 是一个干净、易于使用、经过单元测试的框架，适用于 iOS 和 OSX，它封装了 libssh2。以下是一个简单的使用示例：

NMSSHSession *session = [NMSSHSession connectToHost:@"127.0.0.1:22"
                                       withUsername:@"user"];

if (session.isConnected) {
    [session authenticateByPassword:@"pass"];

    if (session.isAuthorized) {
        NSLog(@"Authentication succeeded");
    }
}
    
NSError *error = nil;
NSString *response = [session.channel execute:@"ls -l /var/www/" error:&error];
NSLog(@"List of my sites: %@", response);
    
BOOL success = [session.channel uploadFile:@"~/index.html" to:@"/var/www/9muses.se/"];

[session disconnect];

3. 项目 API 使用文档

NMSSH 的 API 文档可以在 http://cocoadocs.org/docsets/NMSSH/ 找到。以下是一些常用的 API 示例：

3.1 连接到主机

NMSSHSession *session = [NMSSHSession connectToHost:@"127.0.0.1:22" withUsername:@"user"];

3.2 使用密码进行身份验证

[session authenticateByPassword:@"pass"];

3.3 执行远程命令

NSError *error = nil;
NSString *response = [session.channel execute:@"ls -l /var/www/" error:&error];

3.4 上传文件

BOOL success = [session.channel uploadFile:@"~/index.html" to:@"/var/www/9muses.se/"];

3.5 断开连接

[session disconnect];

4. 项目安装方式

NMSSH 可以通过以下几种方式进行安装：

• CocoaPods: 使用 pod 'NMSSH' 进行安装。
• Carthage: 使用 github "NMSSH/NMSSH" 进行安装。
• 源码构建: 参考 Wiki 页面进行手动构建。

通过以上步骤，你可以轻松地将 NMSSH 集成到你的项目中，并使用其提供的功能进行 SSH 连接和操作。