HouseMD 使用与安装指南

1. 安装指南

1.1 系统要求

• JDK 6 或更高版本

1.2 安装方式

HouseMD 可以通过 jenv 进行安装。jenv 是一个管理不同版本 JDK 的工具。以下是安装步骤：

jenv install housemd

请注意，目前 HouseMD 不支持 Windows 系统。

2. 项目的使用说明

HouseMD 是一个交互式命令行工具，用于诊断 Java 进程的运行时问题。它灵感来源于 BTrace，但更易于使用且更安全。

2.1 启动 HouseMD

使用以下命令启动 HouseMD：

housemd -h

你将看到帮助信息，如下所示：

Usage: housemd [OPTIONS] pid

其中 pid 是你想要诊断的进程 ID。

2.2 使用 HouseMD 命令

启动后，你将看到提示符 housemd>。以下是可用的命令：

• help: 显示帮助信息。
• quit: 终止进程。
• trace: 显示或输出方法调用信息。
• loaded: 显示已加载的类信息。
• env: 显示系统环境变量。
• inspect: 显示类的字段信息。

例如，要查看已加载的类信息，可以输入：

housemd> loaded

2.3 查看帮助信息

对于每个命令，你可以通过 help 命令获取更详细的帮助信息。例如：

housemd> help loaded

这将显示 loaded 命令的使用方法。

3. 项目API使用文档

目前 HouseMD 的 API 文档并不公开，但你可以通过源代码来了解其内部实现和工作原理。如果你想更深入地了解 HouseMD 的功能，建议查看其 GitHub 仓库中的源代码和相关的 commit 记录。

4. 项目安装方式

除了通过 jenv 安装外，你也可以通过以下步骤从源代码构建 HouseMD：

git clone https://github.com/zhongl/HouseMD.git
cd HouseMD
sbt proguard

构建完成后，会在 target/scala-版本号/ 目录下生成一个可运行的 JAR 文件。运行如下命令启动 HouseMD：

java -Xbootclasspath/a:$JAVA_HOME/lib/tools.jar -jar housemd_版本号.jar [OPTIONS] <pid>

在 Mac OS X 上，-Xbootclasspath 参数可能不是必需的。

以上就是 HouseMD 的安装与使用指南。希望这篇文章能帮助你更好地理解和使用这个工具。如果你有任何问题或建议，请随时在 GitHub 仓库中提出。