https://github.com/dikkadev/help2table

help2table
https://github.com/dikkadev/help2table

Last synced: 29 days ago
JSON representation

help2table

• Host: GitHub
• URL: https://github.com/dikkadev/help2table
• Owner: dikkadev
• License: mit
• Created: 2023-03-30T09:54:41.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-30T09:57:02.000Z (over 3 years ago)
• Last Synced: 2026-01-22T01:38:21.980Z (6 months ago)
• Language: Rust
• Size: 18.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Introduction

`help2table` is a tool that uses OpenAI AI models to generate a markdown table of arguments from the help message of a command. It is designed for developers and software maintainers who need to generate documentation for their pipelines.

With `help2table`, you can easily generate a markdown table that can be used to document your pipeline and ensure that your documentation is always up to date. We created `help2table` to make it easier for you to generate accurate documentation, without the need for manual labor.

# Installation

To install `help2table`, you can use the following command:

```bash

$ cargo install help2table

```

This will install `help2table` via Cargo, the Rust package manager. There are no system requirements or dependencies for installation, so you should be able to install `help2table` without any issues.

# Usage

The basic usage of `help2table` is as follows:

`Usage: help2table [OPTIONS] `

To generate a markdown table from the help message of a command, simply run `help2table` followed by the command that returns the help message.

Here are some important command line options and arguments that users should be aware of:

| Short | Long        | Description                       | Default     |

| ----- | ----------- | --------------------------------- | ----------- |

|       | COMMAND     | Command that returns help message |             |

| -m    | --model     | Model to use                      | gpt35-turbo |

| -p    | --pipable   | Print only the table output       |             |

| -c    | --clipboard | Put the table output in clipboard |             |

| -h    | --help      | Print help                        |             |

| -V    | --version   | Print version                     |             |

# License

`help2table2` is released under the MIT License. Please see the [LICENSE](/LICENSE) file for more information.