5分钟内部署claude-hud,实时监控Claude Code
claude-hud是一个Claude Code插件,提供实时监控功能,包括项目路径、上下文健康状况、工具活动、代理跟踪和待办事项进度。通过本教程,您可以快速部署claude-hud,并掌握其使用方法。
1. 安装claude-hud
安装 claude-hud 是我们使用 Claude Code 的第一步。我们需要在 Claude Code 实例中运行几个命令来完成安装。首先,我们需要添加 marketplace,接着安装 claude-hud 插件,最后配置状态栏。
在开始之前,请确保你已经安装了 Claude Code 并且有一个可用的实例。我们将从添加 marketplace 开始。运行以下命令:
/plugin marketplace add jarrodwatts/claude-hud这个命令将添加 claude-hud 的 marketplace,这样我们就可以安装该插件了。
接下来,我们需要安装 claude-hud 插件。运行以下命令:
/plugin install claude-hud这个命令将安装 claude-hud 插件。如果你是 Linux 用户,可能需要设置 TMPDIR 环境变量来避免安装失败。具体来说,你可以运行以下命令:
mkdir -p ~/.cache/tmp && TMPDIR=~/.cache/tmp claude然后,在新的会话中运行安装命令。
安装完成后,我们需要重新加载插件。运行以下命令:
/reload-plugins这个命令将重新加载所有插件,包括我们刚刚安装的 claude-hud。
最后,我们需要配置状态栏。运行以下命令:
/claude-hud:setup这个命令将配置 claude-hud 的状态栏。如果你是 Windows 用户,可能需要安装 Node.js 来完成配置。具体来说,你可以运行以下命令:
winget install OpenJS.NodeJS.LTS然后重启你的 shell 并重新运行配置命令。
安装和配置完成后,重启你的 Claude Code 实例,claude-hud 就会生效了。
本章小结
- 添加 marketplace:
/plugin marketplace add jarrodwatts/claude-hud - 安装 claude-hud 插件:
/plugin install claude-hud - 重新加载插件:
/reload-plugins - 配置状态栏:
/claude-hud:setup - 重启 Claude Code 实例使 claude-hud 生效
2. 配置claude-hud
配置claude-hud是使用该插件的关键步骤,通过配置,我们可以定制HUD的显示内容、布局和语言等。让我们一步一步地完成配置。
首先,我们需要确保claude-hud已经安装并启用。假设你已经完成了安装和启用,下一步就是配置HUD的显示。
我们可以通过运行 /claude-hud:setup 命令来开始配置过程。这个命令会引导你完成配置流程,包括选择预设、语言和个性化设置。
/claude-hud:setup在配置流程中,你会被提示选择一个预设。预设有三个选项:Full、Essential和Minimal。每个预设都对应着不同的显示内容。
| 预设 | 显示内容 |
|---|---|
| Full | 所有内容启用,包括工具、代理、待办事项、Git状态、使用情况和持续时间 |
| Essential | 活动行、Git状态和最少的信息 |
| Minimal | 核心内容,只显示模型名称和上下文条 |
选择一个预设后,你可以根据需要开启或关闭个别元素。
如果你需要更高级的配置,可以直接编辑 ~/.claude/plugins/claude-hud/config.json 文件。这个文件允许你设置诸如颜色、路径级别、最大宽度、阈值覆盖等高级选项。
{
"language": "zh-Hans",
"lineLayout": "expanded",
"pathLevels": 2,
"maxWidth": null,
"forceMaxWidth": false,
"elementOrder": ["project", "addedDirs", "context", "usage", "promptCache", "memory", "environment", "tools", "skills", "mcp", "agents", "todos", "sessionTime"]
}配置完成后,HUD就会根据你的设置显示相应的内容。记得重启Claude Code以使新的配置生效。
本章小结
- 配置claude-hud可以通过
/claude-hud:setup命令开始 - 有三个预设可供选择:Full、Essential和Minimal
- 可以直接编辑
~/.claude/plugins/claude-hud/config.json文件进行高级配置 - 配置完成后,需要重启Claude Code以使新的配置生效
3. 理解claude-hud的功能
我们来深入了解一下 claude-hud 的功能。 claude-hud 是一个 Claude Code 插件,它能够实时显示项目路径、上下文健康状况、工具活动、代理跟踪和待办事项进度等信息。这些信息对于我们更好地理解和管理 Claude Code 会话至关重要。
首先,我们需要了解 claude-hud 显示的信息类型。它可以显示项目路径、上下文健康状况、工具活动、代理跟踪和待办事项进度等信息。每种信息都有其特定的用途和重要性。例如,项目路径可以帮助我们快速识别当前的项目;上下文健康状况可以提醒我们上下文窗口的使用情况;工具活动可以让我们看到 Claude Code 的实时操作;代理跟踪可以显示哪些子代理正在运行和它们的状态;待办事项进度可以实时显示任务的完成情况。
接下来,我们来看一下 claude-hud 的默认显示。默认情况下,claude-hud 会显示两行信息。第一行显示项目路径、git 分支等信息;第二行显示上下文健康状况和使用率限制。我们可以通过 /claude-hud:configure 命令来配置 claude-hud 的显示内容和布局。
/claude-hud:configure在配置过程中,我们可以选择预设的显示模式,例如全模式、基本模式或最小模式。每种模式都有其特定的显示内容和布局。我们也可以根据需要自定义显示内容和布局。
{
"language": "en",
"lineLayout": "expanded",
"pathLevels": 1,
"maxWidth": null,
"forceMaxWidth": false,
"elementOrder": [
"project",
"addedDirs",
"context",
"usage",
"promptCache",
"memory",
"environment",
"tools",
"skills",
"mcp",
"agents",
"todos",
"sessionTime"
]
}claude-hud 使用 Claude Code 的原生 statusline API 来获取和显示信息。它可以实时更新显示内容,每次更新的间隔约为 300 毫秒。 claude-hud 支持多种语言,包括英语和简体中文。
本章小结
- claude-hud 是一个 Claude Code 插件,能够实时显示项目路径、上下文健康状况、工具活动、代理跟踪和待办事项进度等信息。
- claude-hud 的默认显示包括两行信息,第一行显示项目路径和 git 分支,第二行显示上下文健康状况和使用率限制。
- 我们可以通过
/claude-hud:configure命令来配置 claude-hud 的显示内容和布局。 - claude-hud 支持多种语言,包括英语和简体中文。
4. 自定义claude-hud的显示
我们要自定义 claude-hud 的显示了。通过这个过程,你将能够根据自己的需求,定制 claude-hud 的布局、语言和显示内容。
首先,确保你已经安装并配置好了 claude-hud。如果你还没有安装,可以参考前面的章节进行安装和配置。
接下来,我们需要进入 claude-hud 的配置界面。可以通过以下命令进入配置界面:
/claude-hud:configure这个命令会打开一个交互式的配置界面,引导你完成配置过程。
在配置界面中,你可以选择一个预设的布局(Full、Essential 或 Minimal),然后根据需要进行个性化定制。你可以调整布局、语言、显示内容等设置。
如果你想要进行更高级的定制,可以直接编辑 ~/.claude/plugins/claude-hud/config.json 文件。这个文件包含了所有的配置选项,你可以根据需要进行修改。
一些常见的配置选项包括:
language: HUD 标签语言,可以选择en(英语)或zh(简体中文)lineLayout: 布局,可以选择expanded(多行)或compact(单行)pathLevels: 显示的目录层级,可以选择 1、2 或 3maxWidth: 最大宽度,可以设置为一个数字或null
在编辑配置文件时,需要注意 JSON 语法的正确性。错误的语法可能导致配置文件无法被加载。
如果你在配置过程中遇到问题,可以参考 claude-hud 的文档或寻求社区的帮助。
本章小结
- 通过
/claude-hud:configure命令进入 claude-hud 的配置界面 - 可以选择预设的布局(Full、Essential 或 Minimal)并进行个性化定制
- 可以直接编辑
~/.claude/plugins/claude-hud/config.json文件进行高级定制 - 需要注意 JSON 语法的正确性,以避免配置文件加载错误
5. 常见问题和解决方法
我们来解决一些常见的问题和错误,当你在使用 claude-hud 的时候可能会遇到。首先,确保你已经成功安装了 claude-hud 并且已经配置好了。如果你在安装过程中遇到了问题,特别是 Linux 用户可能会遇到的 /tmp 文件系统问题,请确保你已经按照 README 中的步骤设置了 TMPDIR 环境变量。
接着,如果你在 Windows 上遇到了 setup 说没有找到 JavaScript 运行时的问题,请按照 README 中的指示安装 Node.js LTS,然后重启你的 shell 并重新运行 /claude-hud:setup 命令。
如果你在配置 claude-hud 的时候遇到了问题,特别是关于语言和布局的设置,你可以通过运行 /claude-hud:configure 命令来重新配置。这个命令会引导你通过一个设置流程,你可以在这里选择语言、布局和其他选项。
有时候,你可能会遇到 claude-hud 不更新或者显示不正确的问题。这可能是由于配置文件出错或者缓存问题引起的。你可以尝试删除 ~/.claude/plugins/claude-hud/config.json 文件,然后重新运行 /claude-hud:configure 命令来重新生成配置文件。
如果你仍然遇到问题,特别是关于显示和布局的问题,你可以尝试检查你的终端宽度是否正确设置,或者尝试调整 maxWidth 和 forceMaxWidth 选项来解决宽度检测问题。
最后,如果你在使用 claude-hud 的过程中遇到了其他问题,特别是关于工具、代理和待办事项的显示问题,你可以检查你的配置文件是否正确设置了相关选项,或者尝试运行 /claude-hud:configure 命令来重新配置这些选项。
本章小结
- 确保正确安装和配置 claude-hud
- 解决 Linux 和 Windows 上特定的安装和设置问题
- 通过
/claude-hud:configure命令重新配置 claude-hud - 检查和调整配置文件来解决显示和布局问题
- 尝试删除配置文件并重新生成来解决缓存问题
6. 高级配置和定制
高级配置和定制是我们在使用 Claude HUD 时不可或缺的一部分。现在,你已经成功安装并配置了 Claude HUD,那么是时候深入了解如何根据自己的需求定制它了。
首先,我们需要了解 Claude HUD 的配置文件位于 ~/.claude/plugins/claude-hud/config.json。这个文件包含了所有的配置选项,你可以通过编辑这个文件来实现高级定制。
让我们先来看一下如何配置 HUD 的语言。默认情况下,HUD 的语言是英文,但你可以通过设置 language 选项来切换到简体中文。例如:
{
"language": "zh-Hans"
}这样,HUD 的所有标签和提示就会变成简体中文。
接下来,我们可以配置 HUD 的布局。 Claude HUD 提供了两种布局模式:expanded 和 compact。你可以通过设置 lineLayout 选项来切换 между这两种模式。例如:
{
"lineLayout": "compact"
}这样,HUD就会显示在一行内,更加紧凑。
我们还可以配置 HUD 显示的项目路径的目录级别。默认情况下,HUD 只显示一个目录级别,但你可以通过设置 pathLevels 选项来增加或减少目录级别。例如:
{
"pathLevels": 2
}这样,HUD就会显示两个目录级别。
除此之外,Claude HUD 还提供了许多其他的配置选项,例如 maxWidth、forceMaxWidth、elementOrder 等。你可以通过编辑配置文件来实现这些高级定制。
如果你遇到任何问题或需要更多的帮助,你可以通过运行 /claude-hud:configure 命令来打开配置向导。这个向导会引导你完成配置过程,并且可以帮助你预览配置的效果。
本章小结
- Claude HUD 的配置文件位于
~/.claude/plugins/claude-hud/config.json。 - 你可以通过编辑配置文件来实现高级定制,例如配置语言、布局、项目路径的目录级别等。
- Claude HUD 提供了许多其他的配置选项,例如
maxWidth、forceMaxWidth、elementOrder等。 - 你可以通过运行
/claude-hud:configure命令来打开配置向导,获取更多的帮助和预览配置的效果。
7. 实战:将claude-hud集成到您的Claude Code工作流中
我们来谈谈如何将 claude-hud 集成到你的 Claude Code 工作流中。到目前为止,你应该已经安装并配置好了 claude-hud,现在是时候让它发挥作用了。我们的目标是实现实时监控 Claude Code 的运行状态,包括项目路径、上下文健康状况、工具活动、代理跟踪和待办事项进度。
首先,确保你已经完成了前面的章节,特别是安装和配置 claude-hud。如果你还没有运行 /claude-hud:setup 命令,现在是时候运行它了。这个命令会帮助你配置 claude-hud 的显示。
接下来,让我们看看如何自定义 claude-hud 的显示。你可以运行 /claude-hud:configure 命令来进入配置界面。在这里,你可以选择预设的布局、语言和其他选项。例如,你可以选择 "Full" 预设来显示所有的信息,或者选择 "Minimal" 预设来只显示最基本的信息。
现在,让我们来看一个例子。假设你正在使用 Claude Code 来开发一个项目,你想实时监控项目的进度。你可以运行 /claude-hud:configure 命令来配置 claude-hud 的显示,然后选择 "Full" 预设来显示所有的信息。这样,你就可以看到项目路径、上下文健康状况、工具活动、代理跟踪和待办事项进度等信息。
如果你遇到问题,例如 claude-hud 不显示或者显示不正确,你可以检查一下配置文件 ~/.claude/plugins/claude-hud/config.json 来看看是否有错误。同时,你也可以运行 /claude-hud:setup 命令来重新配置 claude-hud。
本章小结
- 将 claude-hud 集成到 Claude Code 工作流中
- 配置 claude-hud 的显示
- 自定义 claude-hud 的布局和语言
- 实时监控 Claude Code 的运行状态
- 解决 claude-hud 配置和显示的问题