@bussolabs/closeyourit-cli 0.0.8 → 0.0.9

package/opencli.json

@@ -15,14 +15,40 @@
     "optionArgumentSeparator": " "
   },
   "options": [
-    {"name": "--help", "aliases": ["-h"], "description": "Show help.", "recursive": true},
-    {"name": "--version", "aliases": ["-V"], "description": "Show CLI version."},
-    {"name": "--json", "description": "Output machine-readable JSON.", "recursive": true}
+    {
+      "name": "--help",
+      "aliases": [
+        "-h"
+      ],
+      "description": "Show help.",
+      "recursive": true
+    },
+    {
+      "name": "--version",
+      "aliases": [
+        "-V"
+      ],
+      "description": "Show CLI version."
+    },
+    {
+      "name": "--json",
+      "description": "Output machine-readable JSON.",
+      "recursive": true
+    }
   ],
   "exitCodes": [
-    {"code": 0, "description": "Success"},
-    {"code": 1, "description": "Runtime or API error"},
-    {"code": 2, "description": "Invalid usage (bad flags/arguments)"}
+    {
+      "code": 0,
+      "description": "Success"
+    },
+    {
+      "code": 1,
+      "description": "Runtime or API error"
+    },
+    {
+      "code": 2,
+      "description": "Invalid usage (bad flags/arguments)"
+    }
   ],
   "commands": [
     {
@@ -32,20 +58,33 @@
         {
           "name": "--api-url",
           "description": "Backend base URL to authenticate against (persisted).",
-          "arguments": [{"name": "URL", "required": true}]
+          "arguments": [
+            {
+              "name": "URL",
+              "required": true
+            }
+          ]
         }
       ],
-      "examples": ["closeyourit login", "closeyourit login --api-url https://staging.closeyour.it"]
+      "examples": [
+        "closeyourit login",
+        "closeyourit login --api-url https://staging.closeyour.it"
+      ]
     },
     {
       "name": "logout",
       "description": "Clear the locally stored token and identity.",
-      "examples": ["closeyourit logout"]
+      "examples": [
+        "closeyourit logout"
+      ]
     },
     {
       "name": "whoami",
       "description": "Show the authenticated account, organization, token and permissions.",
-      "examples": ["closeyourit whoami", "closeyourit whoami --json"]
+      "examples": [
+        "closeyourit whoami",
+        "closeyourit whoami --json"
+      ]
     },
     {
       "name": "projects",
@@ -55,15 +94,34 @@
           "name": "list",
           "description": "List the projects visible to you.",
           "options": [
-            {"name": "--page", "description": "Page number.", "arguments": [{"name": "N"}]}
+            {
+              "name": "--page",
+              "description": "Page number.",
+              "arguments": [
+                {
+                  "name": "N"
+                }
+              ]
+            }
           ],
-          "examples": ["closeyourit projects list", "closeyourit projects list --page 2 --json"]
+          "examples": [
+            "closeyourit projects list",
+            "closeyourit projects list --page 2 --json"
+          ]
         },
         {
           "name": "show",
           "description": "Show a single project by id or key.",
-          "arguments": [{"name": "ID", "description": "Project id (UUID) or key.", "required": true}],
-          "examples": ["closeyourit projects show acme-api"]
+          "arguments": [
+            {
+              "name": "ID",
+              "description": "Project id (UUID) or key.",
+              "required": true
+            }
+          ],
+          "examples": [
+            "closeyourit projects show acme-api"
+          ]
         }
       ]
     },
@@ -75,51 +133,179 @@
           "name": "list",
           "description": "List error groups for a project.",
           "options": [
-            {"name": "--project", "aliases": ["-p"], "required": true, "description": "Project id (UUID) or key.", "arguments": [{"name": "PROJECT", "required": true}]},
-            {"name": "--status", "description": "Filter by status.", "arguments": [{"name": "STATUS"}]},
-            {"name": "--page", "description": "Page number.", "arguments": [{"name": "N"}]}
+            {
+              "name": "--project",
+              "aliases": [
+                "-p"
+              ],
+              "required": true,
+              "description": "Project id (UUID) or key.",
+              "arguments": [
+                {
+                  "name": "PROJECT",
+                  "required": true
+                }
+              ]
+            },
+            {
+              "name": "--status",
+              "description": "Filter by status.",
+              "arguments": [
+                {
+                  "name": "STATUS"
+                }
+              ]
+            },
+            {
+              "name": "--page",
+              "description": "Page number.",
+              "arguments": [
+                {
+                  "name": "N"
+                }
+              ]
+            }
           ],
-          "examples": ["closeyourit errors list --project acme-api --status unresolved"]
+          "examples": [
+            "closeyourit errors list --project acme-api --status unresolved"
+          ]
         },
         {
           "name": "show",
           "description": "Show a single error group.",
-          "arguments": [{"name": "ID", "description": "Error group id.", "required": true}],
+          "arguments": [
+            {
+              "name": "ID",
+              "description": "Error group id.",
+              "required": true
+            }
+          ],
           "options": [
-            {"name": "--project", "aliases": ["-p"], "required": true, "description": "Project id (UUID) or key.", "arguments": [{"name": "PROJECT", "required": true}]}
+            {
+              "name": "--project",
+              "aliases": [
+                "-p"
+              ],
+              "required": true,
+              "description": "Project id (UUID) or key.",
+              "arguments": [
+                {
+                  "name": "PROJECT",
+                  "required": true
+                }
+              ]
+            }
           ],
-          "examples": ["closeyourit errors show <group-id> --project acme-api"]
+          "examples": [
+            "closeyourit errors show <group-id> --project acme-api"
+          ]
         },
         {
           "name": "resolve",
           "description": "Mark an error group as resolved.",
-          "arguments": [{"name": "ID", "description": "Error group id.", "required": true}],
+          "arguments": [
+            {
+              "name": "ID",
+              "description": "Error group id.",
+              "required": true
+            }
+          ],
           "options": [
-            {"name": "--project", "aliases": ["-p"], "required": true, "description": "Project id (UUID) or key.", "arguments": [{"name": "PROJECT", "required": true}]}
+            {
+              "name": "--project",
+              "aliases": [
+                "-p"
+              ],
+              "required": true,
+              "description": "Project id (UUID) or key.",
+              "arguments": [
+                {
+                  "name": "PROJECT",
+                  "required": true
+                }
+              ]
+            }
           ]
         },
         {
           "name": "reopen",
           "description": "Reopen a resolved error group.",
-          "arguments": [{"name": "ID", "description": "Error group id.", "required": true}],
+          "arguments": [
+            {
+              "name": "ID",
+              "description": "Error group id.",
+              "required": true
+            }
+          ],
           "options": [
-            {"name": "--project", "aliases": ["-p"], "required": true, "description": "Project id (UUID) or key.", "arguments": [{"name": "PROJECT", "required": true}]}
+            {
+              "name": "--project",
+              "aliases": [
+                "-p"
+              ],
+              "required": true,
+              "description": "Project id (UUID) or key.",
+              "arguments": [
+                {
+                  "name": "PROJECT",
+                  "required": true
+                }
+              ]
+            }
           ]
         },
         {
           "name": "mute",
           "description": "Mute an error group.",
-          "arguments": [{"name": "ID", "description": "Error group id.", "required": true}],
+          "arguments": [
+            {
+              "name": "ID",
+              "description": "Error group id.",
+              "required": true
+            }
+          ],
           "options": [
-            {"name": "--project", "aliases": ["-p"], "required": true, "description": "Project id (UUID) or key.", "arguments": [{"name": "PROJECT", "required": true}]}
+            {
+              "name": "--project",
+              "aliases": [
+                "-p"
+              ],
+              "required": true,
+              "description": "Project id (UUID) or key.",
+              "arguments": [
+                {
+                  "name": "PROJECT",
+                  "required": true
+                }
+              ]
+            }
           ]
         },
         {
           "name": "unmute",
           "description": "Unmute an error group.",
-          "arguments": [{"name": "ID", "description": "Error group id.", "required": true}],
+          "arguments": [
+            {
+              "name": "ID",
+              "description": "Error group id.",
+              "required": true
+            }
+          ],
           "options": [
-            {"name": "--project", "aliases": ["-p"], "required": true, "description": "Project id (UUID) or key.", "arguments": [{"name": "PROJECT", "required": true}]}
+            {
+              "name": "--project",
+              "aliases": [
+                "-p"
+              ],
+              "required": true,
+              "description": "Project id (UUID) or key.",
+              "arguments": [
+                {
+                  "name": "PROJECT",
+                  "required": true
+                }
+              ]
+            }
           ]
         }
       ]
@@ -132,33 +318,119 @@
           "name": "list",
           "description": "List ingest tokens for a project.",
           "options": [
-            {"name": "--project", "aliases": ["-p"], "required": true, "description": "Project id (UUID) or key.", "arguments": [{"name": "PROJECT", "required": true}]}
+            {
+              "name": "--project",
+              "aliases": [
+                "-p"
+              ],
+              "required": true,
+              "description": "Project id (UUID) or key.",
+              "arguments": [
+                {
+                  "name": "PROJECT",
+                  "required": true
+                }
+              ]
+            }
           ]
         },
         {
           "name": "create",
           "description": "Create an ingest token (the secret is shown only once).",
           "options": [
-            {"name": "--project", "aliases": ["-p"], "required": true, "description": "Project id (UUID) or key.", "arguments": [{"name": "PROJECT", "required": true}]},
-            {"name": "--name", "required": true, "description": "Human-readable token name.", "arguments": [{"name": "NAME", "required": true}]},
-            {"name": "--environment-id", "required": true, "description": "Environment id the token is scoped to.", "arguments": [{"name": "ENV_ID", "required": true}]}
+            {
+              "name": "--project",
+              "aliases": [
+                "-p"
+              ],
+              "required": true,
+              "description": "Project id (UUID) or key.",
+              "arguments": [
+                {
+                  "name": "PROJECT",
+                  "required": true
+                }
+              ]
+            },
+            {
+              "name": "--name",
+              "required": true,
+              "description": "Human-readable token name.",
+              "arguments": [
+                {
+                  "name": "NAME",
+                  "required": true
+                }
+              ]
+            },
+            {
+              "name": "--environment-id",
+              "required": true,
+              "description": "Environment id the token is scoped to.",
+              "arguments": [
+                {
+                  "name": "ENV_ID",
+                  "required": true
+                }
+              ]
+            }
           ],
-          "examples": ["closeyourit tokens create --project acme-api --name \"CI prod\" --environment-id <env-id>"]
+          "examples": [
+            "closeyourit tokens create --project acme-api --name \"CI prod\" --environment-id <env-id>"
+          ]
         },
         {
           "name": "rotate",
           "description": "Rotate an ingest token (the new secret is shown only once).",
-          "arguments": [{"name": "ID", "description": "Token id.", "required": true}],
+          "arguments": [
+            {
+              "name": "ID",
+              "description": "Token id.",
+              "required": true
+            }
+          ],
           "options": [
-            {"name": "--project", "aliases": ["-p"], "required": true, "description": "Project id (UUID) or key.", "arguments": [{"name": "PROJECT", "required": true}]}
+            {
+              "name": "--project",
+              "aliases": [
+                "-p"
+              ],
+              "required": true,
+              "description": "Project id (UUID) or key.",
+              "arguments": [
+                {
+                  "name": "PROJECT",
+                  "required": true
+                }
+              ]
+            }
           ]
         },
         {
           "name": "revoke",
           "description": "Revoke an ingest token.",
-          "arguments": [{"name": "ID", "description": "Token id.", "required": true}],
+          "arguments": [
+            {
+              "name": "ID",
+              "description": "Token id.",
+              "required": true
+            }
+          ],
           "options": [
-            {"name": "--project", "aliases": ["-p"], "required": true, "description": "Project id (UUID) or key.", "arguments": [{"name": "PROJECT", "required": true}]}
+            {
+              "name": "--project",
+              "aliases": [
+                "-p"
+              ],
+              "required": true,
+              "description": "Project id (UUID) or key.",
+              "arguments": [
+                {
+                  "name": "PROJECT",
+                  "required": true
+                }
+              ]
+            }
           ]
         }
       ]
@@ -171,34 +443,163 @@
           "name": "list",
           "description": "List tickets for a project.",
           "options": [
-            {"name": "--project", "aliases": ["-p"], "required": true, "description": "Project id (UUID) or key.", "arguments": [{"name": "PROJECT", "required": true}]},
-            {"name": "--page", "description": "Page number.", "arguments": [{"name": "N"}]}
+            {
+              "name": "--project",
+              "aliases": [
+                "-p"
+              ],
+              "required": true,
+              "description": "Project id (UUID) or key.",
+              "arguments": [
+                {
+                  "name": "PROJECT",
+                  "required": true
+                }
+              ]
+            },
+            {
+              "name": "--page",
+              "description": "Page number.",
+              "arguments": [
+                {
+                  "name": "N"
+                }
+              ]
+            }
           ]
         },
         {
           "name": "show",
           "description": "Show a single ticket.",
-          "arguments": [{"name": "ID", "description": "Ticket id or code.", "required": true}],
+          "arguments": [
+            {
+              "name": "ID",
+              "description": "Ticket id or code.",
+              "required": true
+            }
+          ],
           "options": [
-            {"name": "--project", "aliases": ["-p"], "required": true, "description": "Project id (UUID) or key.", "arguments": [{"name": "PROJECT", "required": true}]}
+            {
+              "name": "--project",
+              "aliases": [
+                "-p"
+              ],
+              "required": true,
+              "description": "Project id (UUID) or key.",
+              "arguments": [
+                {
+                  "name": "PROJECT",
+                  "required": true
+                }
+              ]
+            }
           ]
         },
         {
           "name": "create",
           "description": "Create a ticket.",
           "options": [
-            {"name": "--project", "aliases": ["-p"], "required": true, "description": "Project id (UUID) or key.", "arguments": [{"name": "PROJECT", "required": true}]},
-            {"name": "--title", "required": true, "description": "Ticket title.", "arguments": [{"name": "TITLE", "required": true}]},
-            {"name": "--kind", "description": "Ticket kind (default: bug).", "arguments": [{"name": "KIND"}]},
-            {"name": "--description", "description": "Free-form description.", "arguments": [{"name": "TEXT"}]},
-            {"name": "--step-given", "description": "Given (precondition).", "arguments": [{"name": "TEXT"}]},
-            {"name": "--step-when", "description": "When (action).", "arguments": [{"name": "TEXT"}]},
-            {"name": "--step-then", "description": "Then (outcome).", "arguments": [{"name": "TEXT"}]},
-            {"name": "--step-expected", "description": "Expected result.", "arguments": [{"name": "TEXT"}]},
-            {"name": "--status-id", "description": "Status lookup id.", "arguments": [{"name": "STATUS_ID"}]},
-            {"name": "--priority-id", "description": "Priority lookup id.", "arguments": [{"name": "PRIORITY_ID"}]}
-          ],
-          "examples": ["closeyourit tickets create --project acme-api --title \"Checkout fails\""]
+            {
+              "name": "--project",
+              "aliases": [
+                "-p"
+              ],
+              "required": true,
+              "description": "Project id (UUID) or key.",
+              "arguments": [
+                {
+                  "name": "PROJECT",
+                  "required": true
+                }
+              ]
+            },
+            {
+              "name": "--title",
+              "required": true,
+              "description": "Ticket title.",
+              "arguments": [
+                {
+                  "name": "TITLE",
+                  "required": true
+                }
+              ]
+            },
+            {
+              "name": "--kind",
+              "description": "Ticket kind (default: bug).",
+              "arguments": [
+                {
+                  "name": "KIND"
+                }
+              ]
+            },
+            {
+              "name": "--description",
+              "description": "Free-form description.",
+              "arguments": [
+                {
+                  "name": "TEXT"
+                }
+              ]
+            },
+            {
+              "name": "--step-given",
+              "description": "Given (precondition).",
+              "arguments": [
+                {
+                  "name": "TEXT"
+                }
+              ]
+            },
+            {
+              "name": "--step-when",
+              "description": "When (action).",
+              "arguments": [
+                {
+                  "name": "TEXT"
+                }
+              ]
+            },
+            {
+              "name": "--step-then",
+              "description": "Then (outcome).",
+              "arguments": [
+                {
+                  "name": "TEXT"
+                }
+              ]
+            },
+            {
+              "name": "--step-expected",
+              "description": "Expected result.",
+              "arguments": [
+                {
+                  "name": "TEXT"
+                }
+              ]
+            },
+            {
+              "name": "--status-id",
+              "description": "Status lookup id.",
+              "arguments": [
+                {
+                  "name": "STATUS_ID"
+                }
+              ]
+            },
+            {
+              "name": "--priority-id",
+              "description": "Priority lookup id.",
+              "arguments": [
+                {
+                  "name": "PRIORITY_ID"
+                }
+              ]
+            }
+          ],
+          "examples": [
+            "closeyourit tickets create --project acme-api --title \"Checkout fails\""
+          ]
         }
       ]
     },
@@ -210,17 +611,215 @@
           "name": "list",
           "description": "List performance metric groups for a project.",
           "options": [
-            {"name": "--project", "aliases": ["-p"], "required": true, "description": "Project id (UUID) or key.", "arguments": [{"name": "PROJECT", "required": true}]},
-            {"name": "--kind", "description": "Filter by metric kind (e.g. sql, method).", "arguments": [{"name": "KIND"}]},
-            {"name": "--page", "description": "Page number.", "arguments": [{"name": "N"}]}
+            {
+              "name": "--project",
+              "aliases": [
+                "-p"
+              ],
+              "required": true,
+              "description": "Project id (UUID) or key.",
+              "arguments": [
+                {
+                  "name": "PROJECT",
+                  "required": true
+                }
+              ]
+            },
+            {
+              "name": "--kind",
+              "description": "Filter by metric kind (e.g. sql, method).",
+              "arguments": [
+                {
+                  "name": "KIND"
+                }
+              ]
+            },
+            {
+              "name": "--page",
+              "description": "Page number.",
+              "arguments": [
+                {
+                  "name": "N"
+                }
+              ]
+            }
           ]
         },
         {
           "name": "show",
           "description": "Show a single metric group.",
-          "arguments": [{"name": "ID", "description": "Metric group id.", "required": true}],
+          "arguments": [
+            {
+              "name": "ID",
+              "description": "Metric group id.",
+              "required": true
+            }
+          ],
+          "options": [
+            {
+              "name": "--project",
+              "aliases": [
+                "-p"
+              ],
+              "required": true,
+              "description": "Project id (UUID) or key.",
+              "arguments": [
+                {
+                  "name": "PROJECT",
+                  "required": true
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "name": "servers",
+      "description": "Server monitoring fleet: list/show hosts, rename, pause/resume, revoke, delete; manage enrollment tokens.",
+      "commands": [
+        {
+          "name": "list",
+          "description": "List the monitored servers (fleet snapshot).",
+          "options": [
+            {
+              "name": "--page",
+              "description": "Page number."
+            },
+            {
+              "name": "--status",
+              "description": "Filter by status (repeatable: pending|up|down|paused)."
+            }
+          ]
+        },
+        {
+          "name": "show",
+          "description": "Show a monitored server (latest snapshot).",
+          "arguments": [
+            {
+              "name": "ID",
+              "required": true
+            }
+          ]
+        },
+        {
+          "name": "rename",
+          "description": "Rename a server (display name).",
+          "arguments": [
+            {
+              "name": "ID",
+              "required": true
+            }
+          ],
+          "options": [
+            {
+              "name": "--name",
+              "description": "New display name.",
+              "arguments": [
+                {
+                  "name": "NAME",
+                  "required": true
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "name": "pause",
+          "description": "Pause a server (no staleness/alerts).",
+          "arguments": [
+            {
+              "name": "ID",
+              "required": true
+            }
+          ]
+        },
+        {
+          "name": "resume",
+          "description": "Resume a paused server.",
+          "arguments": [
+            {
+              "name": "ID",
+              "required": true
+            }
+          ]
+        },
+        {
+          "name": "revoke",
+          "description": "Revoke a server: its agent gets 403 and stops.",
+          "arguments": [
+            {
+              "name": "ID",
+              "required": true
+            }
+          ],
           "options": [
-            {"name": "--project", "aliases": ["-p"], "required": true, "description": "Project id (UUID) or key.", "arguments": [{"name": "PROJECT", "required": true}]}
+            {
+              "name": "--confirm",
+              "description": "Required confirmation."
+            }
+          ]
+        },
+        {
+          "name": "unrevoke",
+          "description": "Restore a revoked server.",
+          "arguments": [
+            {
+              "name": "ID",
+              "required": true
+            }
+          ]
+        },
+        {
+          "name": "delete",
+          "description": "Delete a server and all its metrics.",
+          "arguments": [
+            {
+              "name": "ID",
+              "required": true
+            }
+          ],
+          "options": [
+            {
+              "name": "--confirm",
+              "description": "Required confirmation."
+            }
+          ]
+        },
+        {
+          "name": "tokens",
+          "description": "Fleet enrollment tokens.",
+          "commands": [
+            {
+              "name": "list",
+              "description": "List enrollment tokens."
+            },
+            {
+              "name": "create",
+              "description": "Create a token (secret shown once).",
+              "arguments": [
+                {
+                  "name": "NAME",
+                  "required": true
+                }
+              ]
+            },
+            {
+              "name": "revoke",
+              "description": "Revoke an enrollment token.",
+              "arguments": [
+                {
+                  "name": "ID",
+                  "required": true
+                }
+              ],
+              "options": [
+                {
+                  "name": "--confirm",
+                  "description": "Required confirmation."
+                }
+              ]
+            }
           ]
         }
       ]