#markdown-tables #generate-markdown #generate-documentation #table #help #pipeline #command

app help2table

一个将help命令输出转换为markdown表格的工具

1 个不稳定版本

0.1.0 2023年3月30日

#609 in 机器学习

MIT 许可证

20KB
314

简介

help2table 是一个工具,它使用OpenAI AI模型从命令的帮助信息中生成参数的markdown表格。它旨在为需要为他们的管道生成文档的开发人员和软件维护人员设计。

使用 help2table,您可以轻松地生成一个markdown表格,用于记录您的管道,并确保您的文档始终保持最新。我们创建了 help2table 以帮助您更容易地生成准确的文档,而无需手动操作。

安装

要安装 help2table,您可以使用以下命令

$ cargo install help2table

这将通过Cargo(Rust包管理器)安装 help2table。没有安装的系统要求或依赖项,因此您应该能够无任何问题安装 help2table

用法

help2table 的基本用法如下

用法:help2table[选项] <命令>

要从命令的帮助信息中生成markdown表格,只需运行 help2table,后跟返回帮助信息的命令。

以下是用户应了解的一些重要命令行选项和参数

简称 长名称 描述 默认值
命令 返回帮助信息的命令
-m --model 要使用的模型 gpt35-turbo
-p --pipable 仅打印表格输出
-c --clipboard 将表格输出放入剪贴板
-h --help 打印帮助信息
-V --version 打印版本

许可证

help2table2 在MIT许可证下发布。有关更多信息,请参阅 LICENSE 文件。

依赖关系

~23–40MB
~519K SLoC