SoS 项目技术文档

1. 安装指南

1.1 手动安装

你可以直接从 Git 仓库中运行 SoS：

$ sudo ./bin/sos report

或者使用旧的命令：

$ sudo ./bin/sosreport

要查看所有可用的插件和插件选项，运行：

$ sudo ./bin/sos report -l

要本地安装（需要 root 权限）：

# python3 setup.py install

1.2 预构建包安装

Fedora/RHEL 用户

使用 dnf 安装：

# dnf install sos

Debian 用户

使用 apt 安装：

# apt install sosreport

Ubuntu 用户

使用 apt 安装：

# sudo apt install sosreport

1.3 Snap 安装

使用 Snap 安装：

# snap install sosreport --classic

2. 项目使用说明

2.1 基本使用

SoS 是一个可扩展的、便携的支持数据收集工具，主要面向 Linux 发行版和其他类 UNIX 操作系统。你可以通过以下命令生成报告：

$ sudo ./bin/sos report

或者使用旧的命令：

$ sudo ./bin/sosreport

2.2 插件和选项

要查看所有可用的插件和插件选项，运行：

$ sudo ./bin/sos report -l

3. 项目 API 使用文档

SoS 的 API 文档是自动生成的，使用 Sphinx 和 Read the Docs 构建。你可以通过以下步骤在本地生成 HTML 文档：

1. 安装依赖：

pip install -r requirements.txt

2. 生成 HTML 文档：

sphinx-build -b html docs <destination dir>

4. 项目安装方式

SoS 项目可以通过以下几种方式安装：

• 手动安装：从 Git 仓库中直接运行或安装。
• 预构建包安装：通过 dnf、apt 等包管理器安装。
• Snap 安装：使用 Snap 包管理器安装。

通过这些安装方式，你可以轻松地在不同的 Linux 发行版上使用 SoS 项目。