File: output.md

package info (click to toggle)
knack 0.13.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 696 kB
  • sloc: python: 6,261; sh: 8; makefile: 4
file content (16 lines) | stat: -rw-r--r-- 649 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
Output
======

In general, all commands produce an output object that can be converted to any of the available output types by the CLI core.

In other words, commands are output type independent.

Supported output types:
- JSON (human readable, can handle complex objects, useful for queries.
- JSON colored
- Table (human readable format)
- TSV (great for *nix scripting e.g. with awk, grep, etc.)

Table and TSV format can't display nested objects so a user can use the `--query` argument to select the properties they want to display.

The `table_transformer` is available when registering a command to define how it should look in table output.