Hubble 项目技术文档

1. 安装指南

Hubble 是一个在终端中显示任何数据的仪表板。安装 Hubble 的步骤如下：

1. 使用 npm 安装 Hubble：

   npm install -g hubble
   

2. 确保您的路径中包含共享的 npm 库。如果不确定，可以运行以下命令：

   export PATH=/usr/local/share/npm/bin:$PATH
   

3. 启动您的仪表板，输入以下命令：

   hubble
   

2. 项目使用说明

首次启动 Hubble，您将看到一个空白的仪表板界面。可以通过以下方式创建仪表板：

• 按下 'Y' 键创建一个空白的仪表板。
• 按下 'A' 键创建一个 Andromeda 服务器（一个简单的 websocket 服务器）。

创建配置文件 config.coffee 后，您的仪表板将自动重新加载。您可以通过编辑 config.coffee 文件来自定义您的仪表板。

3. 项目API使用文档

Hubble 允许通过 HTTP POST 请求向服务器发送数据，或从磁盘加载数据来配置和填充仪表板。以下是 Hubble 支持的参数列表：

创建条目

• column：定义数据进入的列（最大列数在 config.coffee 中定义）。
• label：在控制台中显示的数据点的名称。

指定 column 和 label 而不包含其他内容将在列中创建居中对齐的文本。若要在控制台中创建一个空行，只需不包含 label。

设置特定值

• value：数据点的值（一个指定的值）。

如果已设置值，并且您想递增或递减它，可以将值设置为 **increment** 或 **decrement**。

轮询值

• poll_url：要轮询的 web 请求的 URL。
• poll_seconds：轮询数据变化的间隔时间。
• poll_failed：请求失败时显示的消息。
• poll_method：应用于结果的方法，以显示结果（接受以下值之一）：
  • count_array：如果端点是数组，计算列表中的数量。
  • json_value:{expression}：从响应中选择一个 JSON 值。

设置阈值

• high：仅适用于数字。超过阈值的数量（数字将显示为配置中的颜色 [红色]）。
• low：仅适用于数字。低于阈值的数量（数字将显示为配置中的颜色 [红色]）。

切换屏幕

• screen：按下特定键时显示的屏幕。

任何时候，您都可以按下 escape 键返回默认屏幕。

4. 项目安装方式

除了使用 npm 安装外，您还可以从源代码安装 Hubble：

1. 克隆这个仓库，然后运行以下命令：

   npm install
   

2. 从源代码运行：

   npm run dev
   

3. 测试：

   npm run test
   

4. 发布（仅适用于维护者）：

   • 更新 package.json 中的版本号。
   • 运行 npm publish。

以上是 Hubble 项目的详细技术文档，希望对您的使用有所帮助。