HelpMe

当您需要时，帮助您的命令行助手。

• 概述
• 背景
• 安装
• 用法
• 贡献
• 示例

概述

HelpMe是一个通用工具，可以支持添加助手或不同模块，这些模块具有一组收集用户所需元数据，并基于内部配置文件定义这些元数据，以及（如果需要）外部配置文件用于用户变量，我们将帮助请求发送到各个助手。例如

• helpme github 在Github板上发布问题
• helpme uservoice 在uservoice上创建票据
• helpme discourse 在discourse板上创建帖子

请提交问题，包括问题、反馈或只是打个招呼，并查看我们完整的文档。

背景

寻求帮助是研究软件用户的标准需求，由于共享集群资源提供的无头环境，通常需要在命令行中执行此功能。虽然交互式Web界面是提交帮助票据和问题以获取帮助的主要途径，但它们与原始命令行（问题产生的地方）相隔甚远，这意味着用户必须中断工作流程，导航到另一个程序，然后进行多次点击，才能尝试手动捕获手头的问题。在最理想的情况下，用户可能只能复制错误消息，然后支持人员需要询问或使用内部资源收集更多信息。这种现实情况并不理想，因为用户通常只提供了一个有限的问题摘要，并且有关系统、环境的信息，甚至实际问题的记录都丢失了。还需要额外的时间进行进一步的沟通和努力来获取这些信息。HelpMe通过直接从源头记录有关问题的信息，并允许用户在不离开工作环境的情况下寻求帮助来解决这些问题。

HelpMe是一款免费开源的命令行工具，其唯一目的是将命令行用户连接到获取帮助的资源。该软件为开发者提供了一个通用框架，以添加“助手”，或不同支持端点，以与“记录器”一起工作，每个“记录器”都以特定方式捕获信息，如消息、终端录制（asciinema）和环境，以便轻松提交到端点。重要的是，将各种应用程序编程接口（API）与用户终端的复杂交互以简单直观的方式呈现，使用户能够控制交互。默认情况下，该软件已准备好与Github和Research Computing中常用的问题跟踪软件UserVoice进行交互。HelpMe的文档基础是从同一存储库生成的，并开放供贡献。它为开发者提供了大量关于添加新的助手、记录器以及用户安装软件的详细信息。

安装

本地

pip install helpme[all]
pip install helpme[github]
pip install helpme[uservoice]

Docker

当前镜像可在quay.io上找到，地址为vanessa/helpme。旧版本可在Docker hub找到。

您可以使用在Docker Hub目录上构建的镜像

$ docker run -it --entrypoint bash quay.io/vanessa/helpme

或者您可以从这个存储库构建它！

$ docker build -t quay.io/vanessa/helpme .

用法

# Post an issue to a Github Repo.
$ helpme github vsoch/helpme

# Post a question to a discourse board
$ helpme discourse

# Post a ticket to UserVoice
$ helpme uservoice

这是一个使用说明的简要概述。对于完整详情，请参阅我们的文档。

贡献

如果您想贡献，我们欢迎拉取请求、功能请求以及您可能提供的任何形式的支持！有关更多详情，请参阅我们的贡献指南。您有疑问或发现了错误吗？您可以提交问题，我们将帮助您。

示例

• rseng-support是一个使用helpme和GitHub的示例问题提交系统

许可证

本代码许可协议为Mozilla 2.0 LICENSE。