@bussolabs/closeyourit-cli 0.0.2

package/opencli.json

@@ -0,0 +1,229 @@
+{
+  "$schema": "https://opencli.org/draft.json",
+  "opencli": "0.1",
+  "info": {
+    "title": "closeyourit",
+    "version": "0.0.1",
+    "summary": "CLI for CloseYourIt",
+    "description": "Manage organization, projects, error monitoring, ingest tokens, tickets and performance metrics with your CloseYourIt user token.",
+    "license": {
+      "name": "UNLICENSED"
+    }
+  },
+  "conventions": {
+    "groupOptions": true,
+    "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}
+  ],
+  "exitCodes": [
+    {"code": 0, "description": "Success"},
+    {"code": 1, "description": "Runtime or API error"},
+    {"code": 2, "description": "Invalid usage (bad flags/arguments)"}
+  ],
+  "commands": [
+    {
+      "name": "login",
+      "description": "Authenticate via the device flow and store your CLI token.",
+      "options": [
+        {
+          "name": "--api-url",
+          "description": "Backend base URL to authenticate against (persisted).",
+          "arguments": [{"name": "URL", "required": true}]
+        }
+      ],
+      "examples": ["closeyourit login", "closeyourit login --api-url https://staging.closeyour.it"]
+    },
+    {
+      "name": "logout",
+      "description": "Clear the locally stored token and identity.",
+      "examples": ["closeyourit logout"]
+    },
+    {
+      "name": "whoami",
+      "description": "Show the authenticated account, organization, token and permissions.",
+      "examples": ["closeyourit whoami", "closeyourit whoami --json"]
+    },
+    {
+      "name": "projects",
+      "description": "Browse visible projects.",
+      "commands": [
+        {
+          "name": "list",
+          "description": "List the projects visible to you.",
+          "options": [
+            {"name": "--page", "description": "Page number.", "arguments": [{"name": "N"}]}
+          ],
+          "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"]
+        }
+      ]
+    },
+    {
+      "name": "errors",
+      "description": "Error monitoring: list, show, triage.",
+      "commands": [
+        {
+          "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"}]}
+          ],
+          "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}],
+          "options": [
+            {"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"]
+        },
+        {
+          "name": "resolve",
+          "description": "Mark an error group as resolved.",
+          "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": "reopen",
+          "description": "Reopen a resolved error group.",
+          "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": "mute",
+          "description": "Mute an error group.",
+          "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": "unmute",
+          "description": "Unmute an error group.",
+          "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": "tokens",
+      "description": "Project ingest tokens (CI/SDK credentials).",
+      "commands": [
+        {
+          "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": "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}]}
+          ],
+          "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}],
+          "options": [
+            {"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}],
+          "options": [
+            {"name": "--project", "aliases": ["-p"], "required": true, "description": "Project id (UUID) or key.", "arguments": [{"name": "PROJECT", "required": true}]}
+          ]
+        }
+      ]
+    },
+    {
+      "name": "tickets",
+      "description": "Tickets: list, show, create.",
+      "commands": [
+        {
+          "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": "show",
+          "description": "Show a single ticket.",
+          "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": "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": "metrics",
+      "description": "Performance metrics (slow queries/methods).",
+      "commands": [
+        {
+          "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": "show",
+          "description": "Show a single metric group.",
+          "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}]}
+          ]
+        }
+      ]
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@bussolabs/closeyourit-cli",
+  "version": "0.0.2",
+  "description": "CLI for CloseYourIt — manage org, errors, tokens and tickets with your user token",
+  "publishConfig": { "access": "public" },
+  "repository": { "type": "git", "url": "git+https://github.com/bussolabs/closeyourit-cli.git" },
+  "license": "MIT",
+  "bin": { "closeyourit": "./bin/run.js", "cyi": "./bin/run.js" },
+  "files": ["/bin", "/dist", "/oclif.manifest.json", "/opencli.json"],
+  "engines": { "node": ">=20" },
+  "dependencies": { "@oclif/core": "^4", "@oclif/plugin-help": "^6" },
+  "devDependencies": { "@types/node": "^22", "oclif": "^4", "typescript": "^5", "vitest": "^2" },
+  "oclif": {
+    "bin": "closeyourit",
+    "dirname": "closeyourit",
+    "commands": "./dist/commands",
+    "topicSeparator": " ",
+    "plugins": ["@oclif/plugin-help"],
+    "topics": {
+      "projects": { "description": "Browse visible projects" },
+      "errors": { "description": "Error monitoring: list, show, triage" },
+      "tokens": { "description": "Project ingest tokens (CI/SDK credentials)" },
+      "tickets": { "description": "Tickets: list, show, create" },
+      "metrics": { "description": "Performance metrics (slow queries/methods)" }
+    }
+  },
+  "scripts": {
+    "build": "tsc -b",
+    "prepack": "pnpm build && oclif manifest",
+    "postpack": "rm -f oclif.manifest.json",
+    "test": "vitest run",
+    "lint": "tsc --noEmit"
+  }
+}