mirror of
https://codeberg.org/scip/tablizer.git
synced 2025-12-16 12:10:57 +01:00
212 lines
7.4 KiB
Markdown
212 lines
7.4 KiB
Markdown
[](https://github.com/tlinden/tablizer/actions)
|
|
[](https://github.com/tlinden/tablizer/blob/master/LICENSE)
|
|
[](https://goreportcard.com/report/github.com/tlinden/tablizer)
|
|
|
|
## tablizer - Manipulate tabular output of other programs
|
|
|
|
Tablizer can be used to re-format tabular output of other
|
|
programs. While you could do this using standard unix tools, in some
|
|
cases it's a hard job.
|
|
|
|
Usage:
|
|
```default
|
|
Usage:
|
|
tablizer [regex] [file, ...] [flags]
|
|
|
|
Operational Flags:
|
|
-c, --columns string Only show the speficied columns (separated by ,)
|
|
-v, --invert-match select non-matching rows
|
|
-n, --no-numbering Disable header numbering
|
|
-N, --no-color Disable pattern highlighting
|
|
-H, --no-headers Disable headers display
|
|
-s, --separator string Custom field separator
|
|
-k, --sort-by int Sort by column (default: 1)
|
|
-z, --fuzzy Use fuzzy search [experimental]
|
|
-F, --filter field=reg Filter given field with regex, can be used multiple times
|
|
-T, --transpose-columns string Transpose the speficied columns (separated by ,)
|
|
-R, --regex-transposer /from/to/ Apply /search/replace/ regexp to fields given in -T
|
|
|
|
Output Flags (mutually exclusive):
|
|
-X, --extended Enable extended output
|
|
-M, --markdown Enable markdown table output
|
|
-O, --orgtbl Enable org-mode table output
|
|
-S, --shell Enable shell evaluable output
|
|
-Y, --yaml Enable yaml output
|
|
-C, --csv Enable CSV output
|
|
-A, --ascii Default output mode, ascii tabular
|
|
-L, --hightlight-lines Use alternating background colors for tables
|
|
|
|
Sort Mode Flags (mutually exclusive):
|
|
-a, --sort-age sort according to age (duration) string
|
|
-D, --sort-desc Sort in descending order (default: ascending)
|
|
-i, --sort-numeric sort according to string numerical value
|
|
-t, --sort-time sort according to time string
|
|
|
|
Other Flags:
|
|
--completion <shell> Generate the autocompletion script for <shell>
|
|
-f, --config <file> Configuration file (default: ~/.config/tablizer/config)
|
|
-d, --debug Enable debugging
|
|
-h, --help help for tablizer
|
|
-m, --man Display manual page
|
|
-V, --version Print program version
|
|
```
|
|
|
|
Let's take this output:
|
|
```
|
|
% kubectl get pods -o wide
|
|
NAME READY STATUS RESTARTS AGE
|
|
repldepl-7bcd8d5b64-7zq4l 1/1 Running 1 (69m ago) 5h26m
|
|
repldepl-7bcd8d5b64-m48n8 1/1 Running 1 (69m ago) 5h26m
|
|
repldepl-7bcd8d5b64-q2bf4 1/1 Running 1 (69m ago) 5h26m
|
|
```
|
|
|
|
But you're only interested in the NAME and STATUS columns. Here's how
|
|
to do this with tablizer:
|
|
|
|
```
|
|
% kubectl get pods | tablizer
|
|
NAME(1) READY(2) STATUS(3) RESTARTS(4) AGE(5)
|
|
repldepl-7bcd8d5b64-7zq4l 1/1 Running 1 (69m ago) 5h26m
|
|
repldepl-7bcd8d5b64-m48n8 1/1 Running 1 (69m ago) 5h26m
|
|
repldepl-7bcd8d5b64-q2bf4 1/1 Running 1 (69m ago) 5h26m
|
|
|
|
% kubectl get pods | tablizer -c 1,3
|
|
NAME(1) STATUS(3)
|
|
repldepl-7bcd8d5b64-7zq4l Running
|
|
repldepl-7bcd8d5b64-m48n8 Running
|
|
repldepl-7bcd8d5b64-q2bf4 Running
|
|
```
|
|
|
|
Another use case is when the tabular output is so wide that lines are
|
|
being broken and the whole output is completely distorted. In such a
|
|
case you can use the `-o extended | -X` flag to get an output similar
|
|
to `\x` in `psql`:
|
|
|
|
```
|
|
% kubectl get pods | tablizer -X
|
|
NAME: repldepl-7bcd8d5b64-7zq4l
|
|
READY: 1/1
|
|
STATUS: Running
|
|
RESTARTS: 1 (71m ago)
|
|
AGE: 5h28m
|
|
|
|
NAME: repldepl-7bcd8d5b64-m48n8
|
|
READY: 1/1
|
|
STATUS: Running
|
|
RESTARTS: 1 (71m ago)
|
|
AGE: 5h28m
|
|
|
|
NAME: repldepl-7bcd8d5b64-q2bf4
|
|
READY: 1/1
|
|
STATUS: Running
|
|
RESTARTS: 1 (71m ago)
|
|
AGE: 5h28m
|
|
```
|
|
|
|
Tablize can read one or more files or - if none specified - from STDIN.
|
|
|
|
You can also specify a regex pattern to reduce the output:
|
|
|
|
```
|
|
% kubectl get pods | tablizer q2bf4
|
|
NAME(1) READY(2) STATUS(3) RESTARTS(4) AGE(5)
|
|
repldepl-7bcd8d5b64-q2bf4 1/1 Running 1 (69m ago) 5h26m
|
|
```
|
|
|
|
Sometimes a filter regex is to broad and you wish to filter only on a
|
|
particular column. This is possible using `-F`:
|
|
```
|
|
% kubectl get pods | tablizer -n -Fname=2
|
|
NAME READY STATUS RESTARTS AGE
|
|
repldepl-7bcd8d5b64-q2bf4 1/1 Running 1 (69m ago) 5h26m
|
|
```
|
|
|
|
Here we filtered the `NAME` column for `2`, which would have matched
|
|
otherwise on all rows.
|
|
|
|
There are more output modes like org-mode (orgtbl) and markdown.
|
|
|
|
You can also use it to modify certain cells using regular expression
|
|
matching. For example:
|
|
|
|
```shell
|
|
kubectl get pods | tablizer -n -T4 -R '/ /-/'
|
|
NAME READY STATUS RESTARTS AGE
|
|
repldepl-7bcd8d5b64-7zq4l 1/1 Running 1-(69m-ago) 5h26m
|
|
repldepl-7bcd8d5b64-m48n8 1/1 Running 1-(69m-ago) 5h26m
|
|
repldepl-7bcd8d5b64-q2bf4 1/1 Running 1-(69m-ago) 5h26m
|
|
```
|
|
|
|
Here, we modified the 4th column (`-T4`) by replacing every space with
|
|
a dash. If you need to work with `/` characters, you can also use any
|
|
other separator, for instance: `-R '| |-|'`.
|
|
|
|
|
|
|
|
## Demo
|
|
|
|
[](https://asciinema.org/a/9FKc3HPnlg8D2X8otheleEa9t)
|
|
|
|
## Installation
|
|
|
|
There are multiple ways to install **tablizer**:
|
|
|
|
- Go to the [latest release page](https://github.com/tlinden/tablizer/releases/latest),
|
|
locate the binary for your operating system and platform.
|
|
|
|
Download it and put it into some directory within your `$PATH` variable.
|
|
|
|
- The release page also contains a tarball for every supported platform. Unpack it
|
|
to some temporary directory, extract it and execute the following command inside:
|
|
```
|
|
sudo make install
|
|
```
|
|
|
|
- You can also install from source. Issue the following commands in your shell:
|
|
```
|
|
git clone https://github.com/TLINDEN/tablizer.git
|
|
cd tablizer
|
|
make
|
|
sudo make install
|
|
```
|
|
|
|
If you do not find a binary release for your platform, please don't
|
|
hesitate to ask me about it, I'll add it.
|
|
|
|
## Documentation
|
|
|
|
The documentation is provided as a unix man-page. It will be
|
|
automatically installed if you install from source. However, you can
|
|
read the man-page online:
|
|
|
|
https://github.com/TLINDEN/tablizer/blob/main/tablizer.pod
|
|
|
|
Or if you cloned the repository you can read it this way (perl needs
|
|
to be installed though): `perldoc tablizer.pod`.
|
|
|
|
If you have the binary installed, you can also read the man page with
|
|
this command:
|
|
|
|
tablizer --man
|
|
|
|
## Getting help
|
|
|
|
Although I'm happy to hear from tablizer users in private email,
|
|
that's the best way for me to forget to do something.
|
|
|
|
In order to report a bug, unexpected behavior, feature requests
|
|
or to submit a patch, please open an issue on github:
|
|
https://github.com/TLINDEN/tablizer/issues.
|
|
|
|
## Copyright and license
|
|
|
|
This software is licensed under the GNU GENERAL PUBLIC LICENSE version 3.
|
|
|
|
## Authors
|
|
|
|
T.v.Dein <tom AT vondein DOT org>
|
|
|
|
## Project homepage
|
|
|
|
https://github.com/TLINDEN/tablizer
|