docs/output-format.rst

   1 Most commands that produce output support the ``--output-format``
   2 parameter. This accepts the following values:
   3
   4 :``text``: Text format (default). Structured data is rendered as a table.
   5
   6 :``json``: JSON (single line).
   7
   8 :``json-pretty``: JSON (multiple lines, nicely formatted).
   9
  10
  11 Also, the following environment variables can modify output behavior:
  12
  13 ``PROXMOX_OUTPUT_FORMAT``
  14   Defines the default output format.
  15
  16 ``PROXMOX_OUTPUT_NO_BORDER``
  17   If set (to any value), do not render table borders.
  18
  19 ``PROXMOX_OUTPUT_NO_HEADER``
  20   If set (to any value), do not render table headers.
  21
  22 .. note:: The ``text`` format is designed to be human readable, and
  23    not meant to be parsed by automation tools. Please use the ``json``
  24    format if you need to process the output.