Add --format=json option to listings

Author: fqqb

docs/yamcs_alarms.rst

@@ -9,6 +9,7 @@ Synopsis
 .. rst-class:: synopsis
 
     | **yamcs alarms** list [--processor <*PROCESSOR*>]
+    |   [--format <*FORMAT*>]
     | **yamcs alarms** acknowledge [--processor <*PROCESSOR*>]
     |    [-c <*COMMENT*>, --comment <*COMMENT*>] <*ALARM*> <*SEQNO*>
     | **yamcs alarms** shelve [--processor <*PROCESSOR*>]
@@ -19,6 +20,7 @@ Synopsis
     |   [-c <*COMMENT*>, --comment <*COMMENT*>] <*ALARM*> <*SEQNO*>
     | **yamcs alarms** log [-n <*LINES*>, --lines <*LINES*>]
     |   [-s <*DATE*>, --since <*DATE*>] [-u <*DATE*>, --until <*DATE*>]
+    |   [--format <*FORMAT*>]
 
 
 Description
@@ -30,7 +32,7 @@ Manage alarms.
 Commands
 --------
 
-.. describe:: list [--processor <PROCESSOR>]
+.. describe:: list [--processor <PROCESSOR>] [--format <FORMAT>]
 
     Show active alarms
 
@@ -50,7 +52,7 @@ Commands
 
     Clear an alarm
 
-.. describe:: log [-n <LINES>, --lines <LINES>] [-s <DATE>, --since <DATE>] [-u <DATE>, --until <DATE>]
+.. describe:: log [-n <LINES>, --lines <LINES>] [-s <DATE>, --since <DATE>] [-u <DATE>, --until <DATE>] [--format <FORMAT>]
 
     Read alarm log
 
@@ -94,6 +96,15 @@ Options
 
     The date should be specified in ISO format or as detailed under `Timestamps`_.
 
+.. option:: --format <FORMAT>
+
+    For subcommands that support it, set the output format to:
+
+    ``table``
+        Print a human-friendly table
+    ``json``
+        Print in JSON format
+
 
 Timestamps
 ----------

docs/yamcs_algorithms.rst

@@ -8,7 +8,7 @@ Synopsis
 
 .. rst-class:: synopsis
 
-    | **yamcs algorithms** list
+    | **yamcs algorithms** list [--format <*FORMAT*>]
     | **yamcs algorithms** describe <*ALGORITHM*>
 
 
@@ -23,8 +23,21 @@ Commands
 
 .. describe:: list
 
-    List algorithms
+    List algorithms [--format <FORMAT>]
 
 .. describe:: describe <ALGORITHM>
 
     Describe an algorithm
+
+
+Options
+-------
+
+.. option:: --format <FORMAT>
+
+    For subcommands that support it, set the output format to:
+
+    ``table``
+        Print a human-friendly table
+    ``json``
+        Print in JSON format

docs/yamcs_commands.rst

@@ -8,14 +8,16 @@ Synopsis
 
 .. rst-class:: synopsis
 
-    | **yamcs commands** list
+    | **yamcs commands** list [--format <*FORMAT*>]
     | **yamcs commands** describe <*COMMAND*>
     | **yamcs commands** run [--stream <*STREAM*>] [--processor <*PROCESSOR*>]
     |   [--dry-run] [--sequence-number <*SEQNO*>] [--arg-file <*FILE*>]
     |   [--arg <*KEY=VALUE*> [<*KEY=VALUE*> ...]]
     |   <*COMMAND*>
     | **yamcs commands** log [-n <*LINES*>, --lines <*LINES*>]
     |   [-s <*DATE*>, --since <*DATE*>] [-u <*DATE*>, --until <*DATE*>]
+    |   [--format <*FORMAT*>]
+
 
 Description
 -----------
@@ -26,7 +28,7 @@ Manage commands.
 Commands
 --------
 
-.. describe:: list
+.. describe:: list [--format <FORMAT>]
 
     List commands
 
@@ -38,7 +40,7 @@ Commands
 
     Run a command
 
-.. describe:: log [-n <LINES>, --lines <LINES>] [-s <DATE>, --since <DATE>] [-u <DATE>, --until <DATE>]
+.. describe:: log [-n <LINES>, --lines <LINES>] [-s <DATE>, --since <DATE>] [-u <DATE>, --until <DATE>] [--format <FORMAT>]
 
     Read command log
 
@@ -92,6 +94,15 @@ Options
 
     The date should be specified in ISO format or as detailed under `Timestamps`_.
 
+.. option:: --format <FORMAT>
+
+    For subcommands that support it, set the output format to:
+
+    ``table``
+        Print a human-friendly table
+    ``json``
+        Print in JSON format
+
 
 Timestamps
 ----------

docs/yamcs_containers.rst

@@ -8,7 +8,7 @@ Synopsis
 
 .. rst-class:: synopsis
 
-    | **yamcs containers** list
+    | **yamcs containers** list [--format <*FORMAT*>]
     | **yamcs containers** describe <*CONTAINER*>
 
 
@@ -28,3 +28,16 @@ Commands
 .. describe:: describe <CONTAINER>
 
     Describe a container
+
+
+Options
+-------
+
+.. option:: --format <FORMAT>
+
+    For subcommands that support it, set the output format to:
+
+    ``table``
+        Print a human-friendly table
+    ``json``
+        Print in JSON format

docs/yamcs_events.rst

@@ -13,7 +13,7 @@ Synopsis
     |   [--type <*TYPE*>] [--extra <*KEY=VALUE*> [<*KEY=VALUE*> ...]]
     | **yamcs events** log [-n <*LINES*>, --lines <*LINES*>]
     |   [-s <*DATE*>, --since <*DATE*>] [-u <*DATE*>, --until <*DATE*>]
-    |   [--filter <*EXPRESSION*>]
+    |   [--filter <*EXPRESSION*>] [--format <*FORMAT*>]
 
 Description
 -----------
@@ -28,7 +28,7 @@ Commands
 
     Create an event. This command shows an editor where you can enter the event message. Alternatively you can specify the message using the ``--message`` option.
 
-.. describe:: log [-n <LINES>, --lines <LINES>] [-s <DATE>, --since <DATE>] [-u <DATE>, --until <DATE>] [--filter <EXPRESSION>]
+.. describe:: log [-n <LINES>, --lines <LINES>] [-s <DATE>, --since <DATE>] [-u <DATE>, --until <DATE>] [--filter <EXPRESSION>] [--format <FORMAT>]
 
     Read event log
 
@@ -91,6 +91,14 @@ Options
 
     With ``log``, include events that match the filter expression.
 
+.. option:: --format <FORMAT>
+
+    For subcommands that support it, set the output format to:
+
+    ``table``
+        Print a human-friendly table
+    ``json``
+        Print in JSON format
 
 Timestamps
 ----------

docs/yamcs_instances.rst

@@ -8,7 +8,7 @@ Synopsis
 
 .. rst-class:: synopsis
 
-    | **yamcs instances** list
+    | **yamcs instances** list [--format <*FORMAT*>]
     | **yamcs instances** start <*INSTANCE*>...
     | **yamcs instances** stop <*INSTANCE*>...
 
@@ -22,7 +22,7 @@ Read Yamcs instances.
 Commands
 --------
 
-.. describe:: list
+.. describe:: list [--format <FORMAT>]
 
     List instances
 
@@ -33,3 +33,16 @@ Commands
 .. describe:: stop <INSTANCE>...
 
     Stop an instance
+
+
+Options
+-------
+
+.. option:: --format <FORMAT>
+
+    For subcommands that support it, set the output format to:
+
+    ``table``
+        Print a human-friendly table
+    ``json``
+        Print in JSON format

docs/yamcs_links.rst

@@ -8,7 +8,7 @@ Synopsis
 
 .. rst-class:: synopsis
 
-    | **yamcs links** list
+    | **yamcs links** list [--format <*FORMAT*>]
     | **yamcs links** enable <*LINK*>...
     | **yamcs links** disable <*LINK*>...
     | **yamcs links** describe <*LINK*>
@@ -24,7 +24,7 @@ Read and manipulate data links.
 Commands
 --------
 
-.. describe:: list
+.. describe:: list [--format <FORMAT>]
 
     List links
 
@@ -43,3 +43,16 @@ Commands
 .. describe:: run-action
 
     Run a custom action
+
+
+Options
+-------
+
+.. option:: --format <FORMAT>
+
+    For subcommands that support it, set the output format to:
+
+    ``table``
+        Print a human-friendly table
+    ``json``
+        Print in JSON format

docs/yamcs_packets.rst

@@ -11,6 +11,7 @@ Synopsis
     | **yamcs packets** log [-p <*PACKET*>, --packet <*PACKET*>]
     |   [-n <*LINES*>, --lines <*LINES*>] [-s <*DATE*>, --since <*DATE*>]
     |   [-u <*DATE*>, --until <*DATE*>] [--filter <*EXPRESSION*>]
+    |   [--format <*FORMAT*>]
     | **yamcs packets** rebuild-histogram [-s <*DATE*>, --since <*DATE*>]
     |   [-u <*DATE*>, --until <*DATE*>]
     | **yamcs packets** rebuild-ccsds-index [-s <*DATE*>, --since <*DATE*>]
@@ -25,7 +26,7 @@ Read packets.
 Commands
 --------
 
-.. describe:: log [-p <PACKET> --packet <PACKET>] [-n <LINES>, --lines <LINES>] [-s <DATE>, --since <DATE>] [-u <DATE>, --until <DATE>] [--filter <EXPRESSION>]
+.. describe:: log [-p <PACKET> --packet <PACKET>] [-n <LINES>, --lines <LINES>] [-s <DATE>, --since <DATE>] [-u <DATE>, --until <DATE>] [--filter <EXPRESSION>] [--format <FORMAT>]
 
     Read packet log
 
@@ -69,6 +70,15 @@ Options
 
     With ``log``, include packets that match the filter expression.
 
+.. option:: --format <FORMAT>
+
+    For subcommands that support it, set the output format to:
+
+    ``table``
+        Print a human-friendly table
+    ``json``
+        Print in JSON format
+
 
 Timestamps
 ----------

docs/yamcs_parameters.rst

@@ -8,7 +8,7 @@ Description
 
 .. rst-class:: synopsis
 
-    | **yamcs parameters** list
+    | **yamcs parameters** list [--format <*FORMAT*>]
     | **yamcs parameters** describe <*PARAMETER*>
     | **yamcs parameters** get [--next [--timeout <*TIMEOUT*>]] <*PARAMETER*>
     | **yamcs parameters** set [--date <*DATE*>] <*PARAMETER*> <*VALUE*>
@@ -25,7 +25,7 @@ Manage parameters.
 Commands
 --------
 
-.. describe:: list
+.. describe:: list [--format <FORMAT>]
 
     List parameters
 
@@ -87,6 +87,15 @@ Options
 
     The date should be specified in ISO format or as detailed under `Timestamps`_.
 
+.. option:: --format <FORMAT>
+
+    For subcommands that support it, set the output format to:
+
+    ``table``
+        Print a human-friendly table
+    ``json``
+        Print in JSON format
+
 
 Timestamps
 ----------

docs/yamcs_processors.rst

@@ -8,7 +8,7 @@ Synopsis
 
 .. rst-class:: synopsis
 
-    | **yamcs processors** list
+    | **yamcs processors** list [--format <*FORMAT*>]
     | **yamcs processors** delete <*PROCESSOR*>
 
 
@@ -21,10 +21,23 @@ Manage processors.
 Commands
 --------
 
-.. describe:: list
+.. describe:: list [--format <FORMAT>]
 
     List processors
 
 .. describe:: delete <PROCESSOR>
 
     Delete a processor
+
+
+Options
+-------
+
+.. option:: --format <FORMAT>
+
+    For subcommands that support it, set the output format to:
+
+    ``table``
+        Print a human-friendly table
+    ``json``
+        Print in JSON format