SSHSync 项目启动与配置教程

1. 项目目录结构及介绍

SSHSync 是一个通过 SSH 在多台远程服务器上执行命令和传输文件的 Python 工具。以下是项目的目录结构及其组成部分的简要介绍：

sshsync/
├── .github/              # GitHub 工作流文件
│   └── workflows/
├── src/                  # 源代码目录
│   └── sshsync/          # SSHSync 主模块
├── .gitignore            # Git 忽略文件
├── .python-version       # 指定项目 Python 版本
├── LICENSE               # MIT 许可证文件
├── README.md             # 项目说明文件
├── demo.gif              # 演示 GIF 图片
├── pyproject.toml        # Python 项目配置文件
├── pyrightconfig.json    # Pyright 配置文件
└── uv.lock               # Uvicorn 锁文件

• .github/workflows/：包含项目的自动化工作流，例如持续集成和持续部署的配置。
• src/sshsync/：存放 SSHSync 工具的源代码。
• .gitignore：定义了哪些文件和目录应该被 Git 忽略。
• .python-version：指定了项目所需的 Python 版本。
• LICENSE：项目的 MIT 许可证。
• README.md：项目的说明文档，包含了项目描述、安装、使用方法和示例等。
• demo.gif：项目的功能演示动画。
• pyproject.toml：用于定义项目信息和依赖。
• pyrightconfig.json：Pyright 代码分析工具的配置文件。
• uv.lock：Uvicorn 服务的锁文件。

2. 项目的启动文件介绍

SSHSync 的启动主要是通过命令行接口（CLI）实现的。项目没有特定的启动文件，而是通过 pip 安装后直接使用命令行工具 sshsync。

安装 SSHSync：

pip install sshsync

安装完成后，可以在命令行中直接使用 sshsync 命令来执行操作，如运行命令、传输文件等。

3. 项目的配置文件介绍

SSHSync 使用 YAML 格式的配置文件来管理服务器组和 SSH 连接。配置文件通常位于 ~/.config/sshsync/config.yaml。

配置文件的示例结构如下：

groups:
  dev:
    - example.site
  work:
    - work.dev
    - ssh.work.dev
  web:
    - cloudmesh
    - example.com

在这个配置文件中，groups 键下的每一项都是一个组，每个组可以有多个主机。这些主机是通过 SSH 别名（即 Host 指令）来引用的，这些别名需要在 ~/.ssh/config 文件中定义。

要编辑配置文件，可以直接手动修改 config.yaml 文件，或者使用 SSHSync 提供的命令来管理组和主机。

使用 sshsync sync 命令可以给未分组的所有主机分配组，而 sshsync gadd 命令可以向特定组中添加主机。通过这些命令，可以维护一个清晰和易于管理的主机分组列表。