add documentation for SK Tools commands and table usage
This commit is contained in:
26
docs/Commands.md
Normal file
26
docs/Commands.md
Normal file
@@ -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 <json|csv|tsv>] [--header|-H <definition|auto|a|original|o>] [global options]`
|
||||
|
||||
**Options:**
|
||||
|
||||
- `--from`, `-F` <json|csv|tsv> - Input format read from stdin. Default: `json`.
|
||||
- `--header`, `-H` <definition|auto|a|original|o> - 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> - JMESPath filter applied before rendering.
|
||||
- `--output`, `-o` <format> - 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.
|
||||
Reference in New Issue
Block a user