diff --git a/.circleci/config.yml b/.circleci/config.yml deleted file mode 100644 index 055e24b..0000000 --- a/.circleci/config.yml +++ /dev/null @@ -1,38 +0,0 @@ ---- -version: 2.1 - -jobs: - compile: - docker: - - image: cimg/go:1.18 - steps: - - checkout - - run: make - - test: - parameters: - go_version: - type: string - run_test: - type: boolean - default: true - docker: - - image: cimg/go:<< parameters.go_version >> - steps: - - checkout - - run: make test - -workflows: - version: 2 - unit-test: - jobs: - - compile - - test: - name: testing - matrix: - parameters: - go_version: - - "1.16" - - "1.17" - - "1.18" - - "1.19" diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml new file mode 100644 index 0000000..3eada6e --- /dev/null +++ b/.github/workflows/ci.yaml @@ -0,0 +1,25 @@ +name: build-tast-tablizer +on: [push, pull_request] +jobs: + build: + strategy: + matrix: + version: [1.17, 1.18, 1.19] + os: [ubuntu-latest, windows-latest, macos-latest] + name: Build + runs-on: ${{ matrix.os }} + steps: + - name: Set up Go 1.18 + uses: actions/setup-go@v3 + with: + go-version: ${{ matrix.version }} + id: go + + - name: checkout + uses: actions/checkout@v3 + + - name: build + run: make + + - name: test + run: make test diff --git a/Makefile b/Makefile index a053f9d..f106b40 100644 --- a/Makefile +++ b/Makefile @@ -18,19 +18,30 @@ # # no need to modify anything below tool = tablizer -version = $(shell egrep "^var Version = " lib/common.go | cut -d'=' -f2 | cut -d'"' -f 2) +version = $(shell egrep "= .v" lib/common.go | cut -d'=' -f2 | cut -d'"' -f 2) archs = android darwin freebsd linux netbsd openbsd windows -PREFIX = /usr/local -UID = root -GID = 0 +PREFIX = /usr/local +UID = root +GID = 0 +BRANCH = $(shell git describe --all | cut -d/ -f2) +COMMIT = $(shell git rev-parse --short=8 HEAD) +BUILD = $(shell date +%Y.%m.%d.%H%M%S) +VERSION:= $(if $(filter $(BRANCH), development),$(version)-$(BRANCH)-$(COMMIT)-$(BUILD)) -all: buildlocal $(tool).1 + +all: $(tool).1 cmd/$(tool).go buildlocal %.1: %.pod pod2man -c "User Commands" -r 1 -s 1 $*.pod > $*.1 +cmd/%.go: %.pod + echo "package cmd" > cmd/$*.go + echo "var manpage = \`" >> cmd/$*.go + pod2text $*.pod >> cmd/$*.go + echo "\`" >> cmd/$*.go + buildlocal: - go build + go build -ldflags "-X 'github.com/tlinden/tablizer/lib.VERSION=$(VERSION)'" release: ./mkrel.sh $(tool) $(version) @@ -42,7 +53,7 @@ install: buildlocal install -o $(UID) -g $(GID) -m 444 $(tool).1 $(PREFIX)/man/man1/ clean: - rm -rf $(tool) $(tool).1 releases + rm -rf $(tool) releases test: go test -v ./... diff --git a/README.md b/README.md index eaf7715..48118f2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -[![](https://circleci.com/gh/TLINDEN/tablizer.svg?style=svg)](https://app.circleci.com/pipelines/github/TLINDEN/tablizer) +[![Actions](https://github.com/tlinden/tablizer/workflows/build/badge.svg)](https://github.com/tlinden/tablizer/actions) +[![License](https://img.shields.io/badge/license-GPL-blue.svg)](https://github.com/tlinden/tablizer/blob/master/LICENSE) ## tablizer - Manipulate tabular output of other programs diff --git a/TODO b/TODO index 73b8d16..8b13789 100644 --- a/TODO +++ b/TODO @@ -1,5 +1 @@ -Add a mode like FreeBSD stat(1): - -stat -s dead.letter -st_dev=170671546954750497 st_ino=159667 st_mode=0100644 st_nlink=1 st_uid=1001 st_gid=1001 st_rdev=18446744073709551615 st_size=573 st_atime=1661994007 st_mtime=1661961878 st_ctime=1661961878 st_birthtime=1658394900 st_blksize=4096 st_blocks=3 st_flags=2048 diff --git a/cmd/root.go b/cmd/root.go index 6d047eb..ddd0d31 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -17,19 +17,43 @@ along with this program. If not, see . package cmd import ( - "daemon.de/tablizer/lib" + "bytes" + "github.com/tlinden/tablizer/lib" "fmt" "github.com/spf13/cobra" + "log" "os" + "os/exec" ) +var helpCmd = &cobra.Command{ + Use: "help", + Short: "Show documentation", + Run: func(cmd *cobra.Command, args []string) { + man := exec.Command("less", "-") + + var b bytes.Buffer + b.Write([]byte(manpage)) + + man.Stdout = os.Stdout + man.Stdin = &b + man.Stderr = os.Stderr + + err := man.Run() + + if err != nil { + log.Fatal(err) + } + }, +} + var rootCmd = &cobra.Command{ Use: "tablizer [regex] [file, ...]", Short: "[Re-]tabularize tabular data", Long: `Manipulate tabular output of other programs`, RunE: func(cmd *cobra.Command, args []string) error { if lib.ShowVersion { - fmt.Printf("This is tablizer version %s\n", lib.Version) + fmt.Printf("This is tablizer version %s\n", lib.VERSION) return nil } @@ -65,11 +89,20 @@ func init() { rootCmd.PersistentFlags().BoolVarP(&lib.OutflagExtended, "extended", "X", false, "Enable extended output") rootCmd.PersistentFlags().BoolVarP(&lib.OutflagMarkdown, "markdown", "M", false, "Enable markdown table output") rootCmd.PersistentFlags().BoolVarP(&lib.OutflagOrgtable, "orgtbl", "O", false, "Enable org-mode table output") - rootCmd.MarkFlagsMutuallyExclusive("extended", "markdown", "orgtbl") + rootCmd.PersistentFlags().BoolVarP(&lib.OutflagShell, "shell", "S", false, "Enable shell mode output") + rootCmd.MarkFlagsMutuallyExclusive("extended", "markdown", "orgtbl", "shell") rootCmd.Flags().MarkHidden("extended") rootCmd.Flags().MarkHidden("orgtbl") rootCmd.Flags().MarkHidden("markdown") + rootCmd.Flags().MarkHidden("shell") // same thing but more common, takes precedence over above group - rootCmd.PersistentFlags().StringVarP(&lib.OutputMode, "output", "o", "", "Output mode - one of: orgtbl, markdown, extended, ascii(default)") + rootCmd.PersistentFlags().StringVarP(&lib.OutputMode, "output", "o", "", "Output mode - one of: orgtbl, markdown, extended, shell, ascii(default)") + + rootCmd.AddCommand(helpCmd) + + rootCmd.SetHelpCommand(&cobra.Command{ + Use: "no-help", + Hidden: true, + }) } diff --git a/cmd/tablizer.go b/cmd/tablizer.go new file mode 100644 index 0000000..f7e26ad --- /dev/null +++ b/cmd/tablizer.go @@ -0,0 +1,128 @@ +package cmd +var manpage = ` +NAME + tablizer - Manipulate tabular output of other programs + +SYNOPSIS + Usage: + tablizer [regex] [file, ...] [flags] + + Flags: + -c, --columns string Only show the speficied columns (separated by ,) + -d, --debug Enable debugging + -h, --help help for tablizer + -n, --no-numbering Disable header numbering + -o, --output string Output mode - one of: orgtbl, markdown, extended, ascii(default) + -X, --extended Enable extended output + -M, --markdown Enable markdown table output + -O, --orgtbl Enable org-mode table output + -s, --separator string Custom field separator + -v, --version Print program version + +DESCRIPTION + Many programs generate tabular output. But sometimes you need to + post-process these tables, you may need to remove one or more columns or + you may want to filter for some pattern or you may need the output in + another program and need to parse it somehow. Standard unix tools such + as awk(1), grep(1) or column(1) may help, but sometimes it's a tedious + business. + + Let's take the output of the tool kubectl. It contains cells with + withespace and they do not separate columns by TAB characters. This is + not easy to process. + + You can use tablizer to do these and more things. + + tablizer analyses the header fiels of a table, registers the column + positions of each header field and separates columns by those positions. + + Without any options it reads its input from "STDIN", but you can also + specify a file as a parameter. If you want to reduce the output by some + regular expression, just specify it as its first parameters. Hence: + + # read from STDIN + kubectl get pods | tablizer + + # read a file + tablizer filename + + # search for pattern in a file (works like grep) + tablizer regex filename + + # search for pattern in STDIN + kubectl get pods | tablizer regex + + The output looks like the original one but every header field will have + a numer associated with it, e.g.: + + NAME(1) READY(2) STATUS(3) RESTARTS(4) AGE(5) + + These numbers denote the column and you can use them to specify which + columns you want to have in your output: + + kubectl get pods | tablizer -c1,3 + + You can specify the numbers in any order but output will always follow + the original order. + + The numbering can be suppressed by using the -n option. + + Finally the -d option enables debugging output which is mostly usefull + for the developer. + + OUTPUT MODES + There might be cases when the tabular output of a program is way too + large for your current terminal but you still need to see every column. + In such cases the -o extended or -X option can be usefull which enables + *extended mode*. In this mode, each row will be printed vertically, + header left, value right, aligned by the field widths. Here's an + example: + + kubectl get pods | ./tablizer -o extended + NAME: repldepl-7bcd8d5b64-7zq4l + READY: 1/1 + STATUS: Running + RESTARTS: 1 (71m ago) + AGE: 5h28m + + You can of course still use a regex to reduce the number of rows + displayed. + + The option -o shell can be used if the output has to be processed by the + shell, it prints variable assignments for each cell, one line per row: + + kubectl get pods | ./tablizer -o extended ./tablizer -o shell + NAME="repldepl-7bcd8d5b64-7zq4l" READY="1/1" STATUS="Running" RESTARTS="9 (47m ago)" AGE="4d23h" + NAME="repldepl-7bcd8d5b64-m48n8" READY="1/1" STATUS="Running" RESTARTS="9 (47m ago)" AGE="4d23h" + NAME="repldepl-7bcd8d5b64-q2bf4" READY="1/1" STATUS="Running" RESTARTS="9 (47m ago)" AGE="4d23h" + + You can use this in an eval loop. + + Beside normal ascii mode (the default) and extended mode there are more + output modes available: orgtbl which prints an Emacs org-mode table and + markdown which prints a Markdown table. + +BUGS + In order to report a bug, unexpected behavior, feature requests or to + submit a patch, please open an issue on github: + . + +LICENSE + This software is licensed under the GNU GENERAL PUBLIC LICENSE version + 3. + + Copyright (c) 2022 by Thomas von Dein + + This software uses the following GO libraries: + + repr (https://github.com/alecthomas/repr) + Released under the MIT License, Copyright (c) 2016 Alec Thomas + + cobra (https://github.com/spf13/cobra) + Released under the Apache 2.0 license, Copyright 2013-2022 The Cobra + Authors + +AUTHORS + Thomas von Dein tom AT vondein DOT org + +` diff --git a/go.mod b/go.mod index 38b9a5b..8b1c9ac 100644 --- a/go.mod +++ b/go.mod @@ -1,4 +1,4 @@ -module daemon.de/tablizer +module github.com/tlinden/tablizer go 1.18 diff --git a/lib/common.go b/lib/common.go index 104d452..dcda314 100644 --- a/lib/common.go +++ b/lib/common.go @@ -17,18 +17,29 @@ along with this program. If not, see . package lib -// command line flags -var Debug bool -var XtendedOut bool -var NoNumbering bool -var ShowVersion bool -var Columns string -var UseColumns []int -var Separator string -var OutflagExtended bool -var OutflagMarkdown bool -var OutflagOrgtable bool -var OutputMode string +var ( + // command line flags + Debug bool + XtendedOut bool + NoNumbering bool + ShowVersion bool + Columns string + UseColumns []int + Separator string + OutflagExtended bool + OutflagMarkdown bool + OutflagOrgtable bool + OutflagShell bool + OutputMode string -var Version = "v1.0.2" -var validOutputmodes = "(orgtbl|markdown|extended|ascii)" + // used for validation + validOutputmodes = "(orgtbl|markdown|extended|ascii)" + + // main program version + Version = "v1.0.4" + + // generated version string, used by -v contains lib.Version on + // main branch, and lib.Version-$branch-$lastcommit-$date on + // development branch + VERSION string +) diff --git a/lib/helpers.go b/lib/helpers.go index ddda4ee..6d047a0 100644 --- a/lib/helpers.go +++ b/lib/helpers.go @@ -20,17 +20,11 @@ package lib import ( "errors" "fmt" - "os" "regexp" "strconv" "strings" ) -func die(v ...interface{}) { - fmt.Fprintln(os.Stderr, v...) - os.Exit(1) -} - func contains(s []int, e int) bool { for _, a := range s { if a == e { @@ -63,6 +57,9 @@ func PrepareModeFlags() error { OutputMode = "markdown" case OutflagOrgtable: OutputMode = "orgtbl" + case OutflagShell: + OutputMode = "shell" + NoNumbering = true default: OutputMode = "ascii" } @@ -82,3 +79,13 @@ func PrepareModeFlags() error { return nil } + +func trimRow(row []string) []string { + // FIXME: remove this when we only use Tablewriter and strip in ParseFile()! + var fixedrow []string + for _, cell := range row { + fixedrow = append(fixedrow, strings.TrimSpace(cell)) + } + + return fixedrow +} diff --git a/lib/io.go b/lib/io.go index 4c6a726..adab95b 100644 --- a/lib/io.go +++ b/lib/io.go @@ -31,7 +31,11 @@ func ProcessFiles(args []string) error { } for _, fd := range fds { - printData(parseFile(fd, pattern)) + data, err := parseFile(fd, pattern) + if err != nil { + return err + } + printData(&data) } return nil diff --git a/lib/parser.go b/lib/parser.go index 0b19e14..53c0af6 100644 --- a/lib/parser.go +++ b/lib/parser.go @@ -19,6 +19,7 @@ package lib import ( "bufio" + "errors" "fmt" "github.com/alecthomas/repr" "io" @@ -43,7 +44,7 @@ type Tabdata struct { way we can turn "tabular data" (with fields containing whitespaces) into real tabular data. We re-tabulate our input if you will. */ -func parseFile(input io.Reader, pattern string) Tabdata { +func parseFile(input io.Reader, pattern string) (Tabdata, error) { data := Tabdata{} var scanner *bufio.Scanner @@ -65,7 +66,7 @@ func parseFile(input io.Reader, pattern string) Tabdata { patternR, err := regexp.Compile(pattern) if err != nil { - die(err) + return data, errors.Unwrap(fmt.Errorf("Regexp pattern %s is invalid: %w", pattern, err)) } if !hadFirst { @@ -145,20 +146,17 @@ func parseFile(input io.Reader, pattern string) Tabdata { idx++ } - if Debug { - fmt.Println() - } data.entries = append(data.entries, values) } } if scanner.Err() != nil { - die(scanner.Err()) + return data, errors.Unwrap(fmt.Errorf("Regexp pattern %s is invalid: %w", pattern, scanner.Err())) } if Debug { repr.Print(data) } - return data + return data, nil } diff --git a/lib/parser_test.go b/lib/parser_test.go index 19218b3..24fca81 100644 --- a/lib/parser_test.go +++ b/lib/parser_test.go @@ -70,7 +70,12 @@ asd igig cxxxncnc 19191 EDD 1 X` readFd := strings.NewReader(table) - gotdata := parseFile(readFd, "") + gotdata, err := parseFile(readFd, "") + + if err != nil { + t.Errorf("Parser returned error: %s\nData processed so far: %+v", err, gotdata) + } + if !reflect.DeepEqual(data, gotdata) { t.Errorf("Parser returned invalid data\nExp: %+v\nGot: %+v\n", data, gotdata) } diff --git a/lib/printer.go b/lib/printer.go index 2f6a056..937757d 100644 --- a/lib/printer.go +++ b/lib/printer.go @@ -25,21 +25,24 @@ import ( "strings" ) -func printData(data Tabdata) { - // prepare headers - // FIXME: maybe do this already in parseFile()? - if !NoNumbering { - numberedHeaders := []string{} - for i, head := range data.headers { - if len(Columns) > 0 { - if !contains(UseColumns, i+1) { - continue - } +func printData(data *Tabdata) { + // prepare headers: add numbers to headers + numberedHeaders := []string{} + for i, head := range data.headers { + if len(Columns) > 0 { + // -c specified + if !contains(UseColumns, i+1) { + // ignore this one + continue } + } + if NoNumbering { + numberedHeaders = append(numberedHeaders, head) + } else { numberedHeaders = append(numberedHeaders, fmt.Sprintf("%s(%d)", head, i+1)) } - data.headers = numberedHeaders } + data.headers = numberedHeaders // prepare data if len(Columns) > 0 { @@ -68,25 +71,17 @@ func printData(data Tabdata) { printOrgmodeData(data) case "markdown": printMarkdownData(data) + case "shell": + printShellData(data) default: printAsciiData(data) } } -func trimRow(row []string) []string { - // FIXME: remove this when we only use Tablewriter and strip in ParseFile()! - var fixedrow []string - for _, cell := range row { - fixedrow = append(fixedrow, strings.TrimSpace(cell)) - } - - return fixedrow -} - /* Emacs org-mode compatible table (also orgtbl-mode) */ -func printOrgmodeData(data Tabdata) { +func printOrgmodeData(data *Tabdata) { tableString := &strings.Builder{} table := tablewriter.NewWriter(tableString) @@ -118,7 +113,7 @@ func printOrgmodeData(data Tabdata) { /* Markdown table */ -func printMarkdownData(data Tabdata) { +func printMarkdownData(data *Tabdata) { table := tablewriter.NewWriter(os.Stdout) table.SetHeader(data.headers) @@ -136,7 +131,7 @@ func printMarkdownData(data Tabdata) { /* Simple ASCII table without any borders etc, just like the input we expect */ -func printAsciiData(data Tabdata) { +func printAsciiData(data *Tabdata) { table := tablewriter.NewWriter(os.Stdout) table.SetHeader(data.headers) @@ -164,7 +159,7 @@ func printAsciiData(data Tabdata) { /* We simulate the \x command of psql (the PostgreSQL client) */ -func printExtendedData(data Tabdata) { +func printExtendedData(data *Tabdata) { // needed for data output format := fmt.Sprintf("%%%ds: %%s\n", data.maxwidthHeader) // FIXME: re-calculate if -c has been set @@ -186,3 +181,26 @@ func printExtendedData(data Tabdata) { } } } + +/* + Shell output, ready to be eval'd. Just like FreeBSD stat(1) +*/ +func printShellData(data *Tabdata) { + if len(data.entries) > 0 { + var idx int + for _, entry := range data.entries { + idx = 0 + for i, value := range entry { + if len(Columns) > 0 { + if !contains(UseColumns, i+1) { + continue + } + } + + fmt.Printf("%s=\"%s\" ", data.headers[idx], value) + idx++ + } + fmt.Println() + } + } +} diff --git a/lib/printer_test.go b/lib/printer_test.go index 5abb75a..9530574 100644 --- a/lib/printer_test.go +++ b/lib/printer_test.go @@ -54,8 +54,13 @@ asd igig cxxxncnc for mode, expect := range expects { OutputMode = mode fd := strings.NewReader(table) - data := parseFile(fd, "") - printData(data) + data, err := parseFile(fd, "") + + if err != nil { + t.Errorf("Parser returned error: %s\nData processed so far: %+v", err, data) + } + + printData(&data) buf := make([]byte, 1024) n, err := r.Read(buf) diff --git a/main.go b/main.go index 0562bcc..fe9d11e 100644 --- a/main.go +++ b/main.go @@ -18,7 +18,7 @@ along with this program. If not, see . package main import ( - "daemon.de/tablizer/cmd" + "github.com/tlinden/tablizer/cmd" ) func main() { diff --git a/tablizer.1 b/tablizer.1 new file mode 100644 index 0000000..92a1660 --- /dev/null +++ b/tablizer.1 @@ -0,0 +1,277 @@ +.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +. ds C` +. ds C' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is >0, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.\" +.\" Avoid warning from groff about undefined register 'F'. +.de IX +.. +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} +. \} +.\} +.rr rF +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "TABLIZER 1" +.TH TABLIZER 1 "2022-10-04" "1" "User Commands" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +tablizer \- Manipulate tabular output of other programs +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +.Vb 2 +\& Usage: +\& tablizer [regex] [file, ...] [flags] +\& +\& Flags: +\& \-c, \-\-columns string Only show the speficied columns (separated by ,) +\& \-d, \-\-debug Enable debugging +\& \-h, \-\-help help for tablizer +\& \-n, \-\-no\-numbering Disable header numbering +\& \-o, \-\-output string Output mode \- one of: orgtbl, markdown, extended, ascii(default) +\& \-X, \-\-extended Enable extended output +\& \-M, \-\-markdown Enable markdown table output +\& \-O, \-\-orgtbl Enable org\-mode table output +\& \-s, \-\-separator string Custom field separator +\& \-v, \-\-version Print program version +.Ve +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +Many programs generate tabular output. But sometimes you need to +post-process these tables, you may need to remove one or more columns +or you may want to filter for some pattern or you may need the output +in another program and need to parse it somehow. Standard unix tools +such as \fBawk\fR\|(1), \fBgrep\fR\|(1) or \fBcolumn\fR\|(1) may help, but sometimes it's a +tedious business. +.PP +Let's take the output of the tool kubectl. It contains cells with +withespace and they do not separate columns by \s-1TAB\s0 characters. This is +not easy to process. +.PP +You can use \fBtablizer\fR to do these and more things. +.PP +\&\fBtablizer\fR analyses the header fiels of a table, registers the column +positions of each header field and separates columns by those +positions. +.PP +Without any options it reads its input from \f(CW\*(C`STDIN\*(C'\fR, but you can also +specify a file as a parameter. If you want to reduce the output by +some regular expression, just specify it as its first +parameters. Hence: +.PP +.Vb 2 +\& # read from STDIN +\& kubectl get pods | tablizer +\& +\& # read a file +\& tablizer filename +\& +\& # search for pattern in a file (works like grep) +\& tablizer regex filename +\& +\& # search for pattern in STDIN +\& kubectl get pods | tablizer regex +.Ve +.PP +The output looks like the original one but every header field will +have a numer associated with it, e.g.: +.PP +.Vb 1 +\& NAME(1) READY(2) STATUS(3) RESTARTS(4) AGE(5) +.Ve +.PP +These numbers denote the column and you can use them to specify which +columns you want to have in your output: +.PP +.Vb 1 +\& kubectl get pods | tablizer \-c1,3 +.Ve +.PP +You can specify the numbers in any order but output will always follow +the original order. +.PP +The numbering can be suppressed by using the \fB\-n\fR option. +.PP +Finally the \fB\-d\fR option enables debugging output which is mostly +usefull for the developer. +.SS "\s-1OUTPUT MODES\s0" +.IX Subsection "OUTPUT MODES" +There might be cases when the tabular output of a program is way too +large for your current terminal but you still need to see every +column. In such cases the \fB\-o extended\fR or \fB\-X\fR option can be +usefull which enables \fIextended mode\fR. In this mode, each row will be +printed vertically, header left, value right, aligned by the field +widths. Here's an example: +.PP +.Vb 6 +\& kubectl get pods | ./tablizer \-o extended +\& NAME: repldepl\-7bcd8d5b64\-7zq4l +\& READY: 1/1 +\& STATUS: Running +\& RESTARTS: 1 (71m ago) +\& AGE: 5h28m +.Ve +.PP +You can of course still use a regex to reduce the number of rows +displayed. +.PP +The option \fB\-o shell\fR can be used if the output has to be processed +by the shell, it prints variable assignments for each cell, one line +per row: +.PP +.Vb 4 +\& kubectl get pods | ./tablizer \-o extended ./tablizer \-o shell +\& NAME="repldepl\-7bcd8d5b64\-7zq4l" READY="1/1" STATUS="Running" RESTARTS="9 (47m ago)" AGE="4d23h" +\& NAME="repldepl\-7bcd8d5b64\-m48n8" READY="1/1" STATUS="Running" RESTARTS="9 (47m ago)" AGE="4d23h" +\& NAME="repldepl\-7bcd8d5b64\-q2bf4" READY="1/1" STATUS="Running" RESTARTS="9 (47m ago)" AGE="4d23h" +.Ve +.PP +You can use this in an eval loop. +.PP +Beside normal ascii mode (the default) and extended mode there are +more output modes available: \fBorgtbl\fR which prints an Emacs org-mode +table and \fBmarkdown\fR which prints a Markdown table. +.SH "BUGS" +.IX Header "BUGS" +In order to report a bug, unexpected behavior, feature requests +or to submit a patch, please open an issue on github: +. +.SH "LICENSE" +.IX Header "LICENSE" +This software is licensed under the \s-1GNU GENERAL PUBLIC LICENSE\s0 version 3. +.PP +Copyright (c) 2022 by Thomas von Dein +.PP +This software uses the following \s-1GO\s0 libraries: +.IP "repr (https://github.com/alecthomas/repr)" 4 +.IX Item "repr (https://github.com/alecthomas/repr)" +Released under the \s-1MIT\s0 License, Copyright (c) 2016 Alec Thomas +.IP "cobra (https://github.com/spf13/cobra)" 4 +.IX Item "cobra (https://github.com/spf13/cobra)" +Released under the Apache 2.0 license, Copyright 2013\-2022 The Cobra Authors +.SH "AUTHORS" +.IX Header "AUTHORS" +Thomas von Dein \fBtom \s-1AT\s0 vondein \s-1DOT\s0 org\fR diff --git a/tablizer.pod b/tablizer.pod index 4808812..0451bbc 100644 --- a/tablizer.pod +++ b/tablizer.pod @@ -74,7 +74,7 @@ The numbering can be suppressed by using the B<-n> option. Finally the B<-d> option enables debugging output which is mostly usefull for the developer. -?head2 OUTPUT MODES +=head2 OUTPUT MODES There might be cases when the tabular output of a program is way too large for your current terminal but you still need to see every @@ -83,7 +83,7 @@ usefull which enables I. In this mode, each row will be printed vertically, header left, value right, aligned by the field widths. Here's an example: - kubectl get pods | ./tablizer -X + kubectl get pods | ./tablizer -o extended NAME: repldepl-7bcd8d5b64-7zq4l READY: 1/1 STATUS: Running @@ -93,6 +93,17 @@ widths. Here's an example: You can of course still use a regex to reduce the number of rows displayed. +The option B<-o shell> can be used if the output has to be processed +by the shell, it prints variable assignments for each cell, one line +per row: + + kubectl get pods | ./tablizer -o extended ./tablizer -o shell + NAME="repldepl-7bcd8d5b64-7zq4l" READY="1/1" STATUS="Running" RESTARTS="9 (47m ago)" AGE="4d23h" + NAME="repldepl-7bcd8d5b64-m48n8" READY="1/1" STATUS="Running" RESTARTS="9 (47m ago)" AGE="4d23h" + NAME="repldepl-7bcd8d5b64-q2bf4" READY="1/1" STATUS="Running" RESTARTS="9 (47m ago)" AGE="4d23h" + +You can use this in an eval loop. + Beside normal ascii mode (the default) and extended mode there are more output modes available: B which prints an Emacs org-mode table and B which prints a Markdown table.