From 36dc8df4b7f949f11a4d387821d03eaaffec159f Mon Sep 17 00:00:00 2001 From: Slawomir Koszewski Date: Fri, 6 Mar 2026 19:05:21 +0100 Subject: [PATCH] add documentation for SK Tools commands and table usage --- docs/Commands.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 docs/Commands.md diff --git a/docs/Commands.md b/docs/Commands.md new file mode 100644 index 0000000..0c34b63 --- /dev/null +++ b/docs/Commands.md @@ -0,0 +1,26 @@ +# SK Tools Commands + +The `sk-tools` package provides generic CLI utilities not tied to a specific cloud provider. + +## Table + +**Command name:** `table` + +**Usage:** `sk-tools table [--from|-F ] [--header|-H ] [global options]` + +**Options:** + +- `--from`, `-F` - Input format read from stdin. Default: `json`. +- `--header`, `-H` - Header definition. Possible values: + - `col1, col2, ...` - Column names separated by comma. The number of columns should match table columns. + - `key1: Col1, key2: Col2, ...` - Property-to-column mapping. + - `auto`, `a` - Header generated automatically from result keys. + - `original`, `o` - Header based on original table shape. + +**Global options:** + +- `--query`, `-q` - JMESPath filter applied before rendering. +- `--output`, `-o` - Output format: `table|t|alignedtable|at|prettytable|pt|tsv`. +- `--help`, `-h` - Show help. + +**Description:** The `table` command transforms stdin data into tabular output. It accepts JSON, CSV, or TSV input and renders either Markdown table variants or TSV output.