Commands and Flags

Commands and Flags

tabtomd follows a standard command-line application structure:

tabtomd [COMMAND] [OPTIONS]
  • [COMMAND]: Specifies the action to perform (see Command List).
  • [OPTIONS]: Optional flags that modify the behavior of the command (see Flag List).

Command List

The most commonly used commands are file and paste, which are often combined with flags to control the output. The table below lists all available commands and their descriptions:

Command Description
file Convert a tab-delimited file to a Markdown table.
paste Convert tab-delimited data from the system clipboard to Markdown.
completion Generate an autocompletion script for a specific shell.
help Display detailed help information for any command.
version Display the tabtomd version and build details.

Flag List

Flags are optional parameters that modify how commands behave. The table below describes the flags available for use with tabtomd:

Flag Description
--output string Specify a file to save the generated Markdown table.
--pretty Align vertical bars in the Markdown table for improved readability.
--print Print the Markdown table directly to standard output.

Examples

For practical demonstrations of how to use commands and flags, visit the examples pages: