lssh 项目教程

lssh 项目教程

lssh List selection type ssh/scp/sftp client command. Supports single connection and parallel connection. Local bashrc can also be used without placing it on a remote machine. Written in Golang. 项目地址: https://gitcode.com/gh_mirrors/ls/lssh

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

lssh 项目的目录结构如下：

lssh/
├── cmd/
│   ├── lssh/
│   ├── lscp/
│   └── lsftp/
├── common/
├── completion/
│   └── zsh/
├── conf/
├── example/
├── images/
├── list/
├── output/
├── package/
├── scp/
├── sftp/
├── ssh/
├── vendor/
├── .gitignore
├── .travis.yml
├── LICENSE.md
├── Makefile
├── README.md
├── go.mod
└── go.sum

目录介绍：

• cmd/: 包含 lssh、lscp 和 lsftp 命令的源代码。
• common/: 包含项目中使用的通用代码。
• completion/: 包含 zsh 自动补全脚本。
• conf/: 包含配置文件相关的代码。
• example/: 包含示例配置文件。
• images/: 包含项目相关的图片资源。
• list/: 包含主机列表相关的代码。
• output/: 包含输出相关的代码。
• package/: 包含包相关的代码。
• scp/: 包含 SCP 相关的代码。
• sftp/: 包含 SFTP 相关的代码。
• ssh/: 包含 SSH 相关的代码。
• vendor/: 包含项目的依赖库。
• .gitignore: Git 忽略文件列表。
• .travis.yml: Travis CI 配置文件。
• LICENSE.md: 项目许可证文件。
• Makefile: 项目构建文件。
• README.md: 项目介绍和使用说明。
• go.mod: Go 模块定义文件。
• go.sum: Go 模块依赖校验文件。

2. 项目的启动文件介绍

lssh 项目的启动文件主要位于 cmd/ 目录下，包括以下几个主要文件：

• cmd/lssh/main.go: 这是 lssh 命令的主入口文件，负责启动 SSH 客户端。
• cmd/lscp/main.go: 这是 lscp 命令的主入口文件，负责启动 SCP 客户端。
• cmd/lsftp/main.go: 这是 lsftp 命令的主入口文件，负责启动 SFTP 客户端。

这些文件通过调用 common/ 目录中的通用代码来实现具体的 SSH、SCP 和 SFTP 功能。

3. 项目的配置文件介绍

lssh 项目的配置文件主要是一个 YAML 格式的文件，通常命名为 ~/.lssh.conf。该文件定义了连接到远程主机的配置信息。

配置文件示例：

[server:localrc]
addr: "192.168.100.104"
key: "/path/to/private_key"
note: "Use local bashrc files"
local_rc: 'yes'
local_rc_compress: true
local_rc_file:
  - "~/dotfiles/.bashrc"
  - "~/dotfiles/bash_prompt"
  - "~/dotfiles/sh_alias"
  - "~/dotfiles/sh_export"
  - "~/dotfiles/sh_function"

配置项说明：

• addr: 远程主机的地址。
• key: 用于 SSH 连接的私钥路径。
• note: 配置的备注信息。
• local_rc: 是否使用本地的 bashrc 文件。
• local_rc_compress: 是否压缩本地 bashrc 文件。
• local_rc_file: 本地 bashrc 文件的路径列表。

通过编辑 ~/.lssh.conf 文件，用户可以自定义连接到不同主机的配置，包括使用本地 bashrc 文件、设置 SSH 代理等高级功能。

lssh List selection type ssh/scp/sftp client command. Supports single connection and parallel connection. Local bashrc can also be used without placing it on a remote machine. Written in Golang. 项目地址: https://gitcode.com/gh_mirrors/ls/lssh