openstack/python-monascaclient
Code Issues Proposed changes
1571a1a3e4
python-monascaclient/doc/source/cli/monasca-formatting.rst
kornicameister 6edcdd4af7 Enable client documentation 
Commit enables following flavours of client's documentation:
- docs: featuring mainly CLI and Python API
- releasenotes: containing all releases releasenotes

Story: 2001058
Task: 5722

Needed-By: Ie064df6f64ee168ad3b5d2dda949b1d14fa7b9d8
Change-Id: I1b0fa11160d8d7d928b4cfbe358ca8c75ed8dd08
2017-11-21 17:31:06 +01:00

1.2 KiB
Raw Blame History

Changing formatting

Changing displayed columns

If you want displayed columns in a list operation, -c option can be used. -c can be specified multiple times and the column order will be same as the order of -c options.

Changing format

If you want to change the format data is displayed in, you can use -f option for that. Format can be specified just once and it affects they way the data is printed to the STDOUT. The available formats, data can be presented in, can be checked with:

monasca <command> --help

Look for section output formatters and the flag --format or -f. In most of the cases you will be able to pick one out of csv, json, table, value, yaml.

Affecting the width

If, for some reason, you are not happy with the width the output has taken, you can use `--max-width {number} flag and set the value to match your preference. Without that output will not be constrained by the terminal width. Alternatively you may want to pass --fit-width to fit the output to display width. Remember that these flags affect the output only if table` formatter is used.