@oneuptime/cli 1.0.0

package/README.md

@@ -0,0 +1,220 @@
+# @oneuptime/cli
+
+Command-line interface for managing OneUptime resources. Supports all MCP-enabled resources with full CRUD operations, named contexts for multiple environments, and flexible output formats.
+
+## Installation
+
+```bash
+npm install -g @oneuptime/cli
+```
+
+Or run directly within the monorepo:
+
+```bash
+cd CLI
+npm install
+npm start -- --help
+```
+
+## Quick Start
+
+```bash
+# Authenticate with your OneUptime instance
+oneuptime login <api-key> <instance-url>
+oneuptime login sk-your-api-key https://oneuptime.com
+
+# List incidents
+oneuptime incident list --limit 10
+
+# Get a single resource by ID
+oneuptime monitor get 550e8400-e29b-41d4-a716-446655440000
+
+# Create a resource
+oneuptime monitor create --data '{"name":"API Health","projectId":"..."}'
+
+# See all available resources
+oneuptime resources
+```
+
+## Authentication & Contexts
+
+The CLI supports multiple authentication contexts, making it easy to switch between environments.
+
+### Setting Up
+
+```bash
+# Create a production context
+oneuptime login sk-prod-key https://oneuptime.com --context-name production
+
+# Create a staging context
+oneuptime login sk-staging-key https://staging.oneuptime.com --context-name staging
+```
+
+### Switching Contexts
+
+```bash
+# List all contexts
+oneuptime context list
+
+# Switch active context
+oneuptime context use staging
+
+# Show current context
+oneuptime context current
+
+# Delete a context
+oneuptime context delete old-context
+```
+
+### Credential Resolution Order
+
+1. CLI flags: `--api-key` and `--url`
+2. Environment variables: `ONEUPTIME_API_KEY` and `ONEUPTIME_URL`
+3. Current context from config file (`~/.oneuptime/config.json`)
+
+## Command Reference
+
+### Authentication
+
+| Command | Description |
+|---|---|
+| `oneuptime login <api-key> <url>` | Authenticate and create a context |
+| `oneuptime context list` | List all contexts |
+| `oneuptime context use <name>` | Switch active context |
+| `oneuptime context current` | Show current context |
+| `oneuptime context delete <name>` | Remove a context |
+| `oneuptime whoami` | Show current auth info |
+
+### Resource Operations
+
+Every discovered resource supports these subcommands:
+
+| Subcommand | Description |
+|---|---|
+| `<resource> list [options]` | List resources with filtering and pagination |
+| `<resource> get <id>` | Get a single resource by ID |
+| `<resource> create --data <json>` | Create a new resource |
+| `<resource> update <id> --data <json>` | Update an existing resource |
+| `<resource> delete <id>` | Delete a resource |
+| `<resource> count [--query <json>]` | Count resources |
+
+### List Options
+
+```
+--query <json>    Filter criteria as JSON
+--limit <n>       Maximum number of results (default: 10)
+--skip <n>        Number of results to skip (default: 0)
+--sort <json>     Sort order as JSON (e.g. '{"createdAt": -1}')
+-o, --output      Output format: json, table, wide
+```
+
+### Utility Commands
+
+| Command | Description |
+|---|---|
+| `oneuptime version` | Print CLI version |
+| `oneuptime whoami` | Show current authentication info |
+| `oneuptime resources` | List all available resource types |
+
+## Output Formats
+
+| Format | Description |
+|---|---|
+| `table` | Formatted ASCII table (default for TTY) |
+| `json` | Raw JSON (default when piped) |
+| `wide` | Table with all columns shown |
+
+```bash
+# Explicit format
+oneuptime incident list -o json
+oneuptime incident list -o table
+oneuptime incident list -o wide
+
+# Pipe to jq (auto-detects JSON)
+oneuptime incident list | jq '.[].title'
+```
+
+## Scripting Examples
+
+```bash
+# List incidents as JSON for scripting
+oneuptime incident list -o json --limit 100
+
+# Count resources with filter
+oneuptime incident count --query '{"currentIncidentStateId":"..."}'
+
+# Create from a JSON file
+oneuptime monitor create --file monitor.json
+
+# Use environment variables in CI/CD
+ONEUPTIME_API_KEY=sk-xxx ONEUPTIME_URL=https://oneuptime.com oneuptime incident list
+```
+
+## Environment Variables
+
+| Variable | Description |
+|---|---|
+| `ONEUPTIME_API_KEY` | API key for authentication |
+| `ONEUPTIME_URL` | OneUptime instance URL |
+| `NO_COLOR` | Disable colored output |
+
+## Configuration File
+
+The CLI stores configuration at `~/.oneuptime/config.json` with `0600` permissions. The file contains:
+
+```json
+{
+  "currentContext": "production",
+  "contexts": {
+    "production": {
+      "name": "production",
+      "apiUrl": "https://oneuptime.com",
+      "apiKey": "sk-..."
+    }
+  },
+  "defaults": {
+    "output": "table",
+    "limit": 10
+  }
+}
+```
+
+## Global Options
+
+| Option | Description |
+|---|---|
+| `--api-key <key>` | Override API key for this command |
+| `--url <url>` | Override instance URL for this command |
+| `--context <name>` | Use a specific context for this command |
+| `-o, --output <format>` | Output format: json, table, wide |
+| `--no-color` | Disable colored output |
+
+## Supported Resources
+
+Run `oneuptime resources` to see all available resource types. Resources are auto-discovered from OneUptime models that have MCP enabled. Currently supported:
+
+- **Incident** - Manage incidents
+- **Alert** - Manage alerts
+- **Monitor** - Manage monitors
+- **Monitor Status** - Manage monitor statuses
+- **Incident State** - Manage incident states
+- **Status Page** - Manage status pages
+- **On-Call Policy** - Manage on-call duty policies
+- **Team** - Manage teams
+- **Scheduled Maintenance Event** - Manage scheduled maintenance
+
+As more models are MCP-enabled in OneUptime, they automatically become available in the CLI.
+
+## Development
+
+```bash
+cd CLI
+npm install
+npm start -- --help     # Run via ts-node
+npm test                # Run tests
+npm run compile         # Type-check
+```
+
+## License
+
+Apache-2.0

package/build/dist/Commands/ConfigCommands.js

@@ -0,0 +1,145 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerConfigCommands = registerConfigCommands;
+const ConfigManager = __importStar(require("../Core/ConfigManager"));
+const OutputFormatter_1 = require("../Core/OutputFormatter");
+const cli_table3_1 = __importDefault(require("cli-table3"));
+const chalk_1 = __importDefault(require("chalk"));
+function registerConfigCommands(program) {
+    // Login command
+    const loginCmd = program
+        .command("login")
+        .description("Authenticate with a OneUptime instance")
+        .argument("<api-key>", "API key for authentication")
+        .argument("<instance-url>", "OneUptime instance URL (e.g. https://oneuptime.com)")
+        .option("--context-name <name>", "Name for this context", "default")
+        .action((apiKey, instanceUrl, options) => {
+        try {
+            const context = {
+                name: options.contextName,
+                apiUrl: instanceUrl.replace(/\/+$/, ""),
+                apiKey: apiKey,
+            };
+            ConfigManager.addContext(context);
+            ConfigManager.setCurrentContext(context.name);
+            (0, OutputFormatter_1.printSuccess)(`Logged in successfully. Context "${context.name}" is now active.`);
+        }
+        catch (error) {
+            (0, OutputFormatter_1.printError)(`Login failed: ${error instanceof Error ? error.message : String(error)}`);
+            process.exit(1);
+        }
+    });
+    // Suppress unused variable warning - loginCmd is used for registration
+    void loginCmd;
+    // Context commands
+    const contextCmd = program
+        .command("context")
+        .description("Manage CLI contexts (environments/projects)");
+    contextCmd
+        .command("list")
+        .description("List all configured contexts")
+        .action(() => {
+        const contexts = ConfigManager.listContexts();
+        if (contexts.length === 0) {
+            (0, OutputFormatter_1.printInfo)("No contexts configured. Run `oneuptime login` to create one.");
+            return;
+        }
+        const noColor = process.env["NO_COLOR"] !== undefined ||
+            process.argv.includes("--no-color");
+        const table = new cli_table3_1.default({
+            head: ["", "Name", "URL"].map((h) => {
+                return noColor ? h : chalk_1.default.cyan(h);
+            }),
+            style: { head: [], border: [] },
+        });
+        for (const ctx of contexts) {
+            table.push([ctx.isCurrent ? "*" : "", ctx.name, ctx.apiUrl]);
+        }
+        // eslint-disable-next-line no-console
+        console.log(table.toString());
+    });
+    contextCmd
+        .command("use <name>")
+        .description("Switch to a different context")
+        .action((name) => {
+        try {
+            ConfigManager.setCurrentContext(name);
+            (0, OutputFormatter_1.printSuccess)(`Switched to context "${name}".`);
+        }
+        catch (error) {
+            (0, OutputFormatter_1.printError)(error instanceof Error ? error.message : String(error));
+            process.exit(1);
+        }
+    });
+    contextCmd
+        .command("current")
+        .description("Show the current active context")
+        .action(() => {
+        const ctx = ConfigManager.getCurrentContext();
+        if (!ctx) {
+            (0, OutputFormatter_1.printInfo)("No current context set. Run `oneuptime login` to create one.");
+            return;
+        }
+        const maskedKey = ctx.apiKey.length > 8
+            ? ctx.apiKey.substring(0, 4) +
+                "****" +
+                ctx.apiKey.substring(ctx.apiKey.length - 4)
+            : "****";
+        // eslint-disable-next-line no-console
+        console.log(`Context: ${ctx.name}`);
+        // eslint-disable-next-line no-console
+        console.log(`URL:     ${ctx.apiUrl}`);
+        // eslint-disable-next-line no-console
+        console.log(`API Key: ${maskedKey}`);
+    });
+    contextCmd
+        .command("delete <name>")
+        .description("Delete a context")
+        .action((name) => {
+        try {
+            ConfigManager.removeContext(name);
+            (0, OutputFormatter_1.printSuccess)(`Context "${name}" deleted.`);
+        }
+        catch (error) {
+            (0, OutputFormatter_1.printError)(error instanceof Error ? error.message : String(error));
+            process.exit(1);
+        }
+    });
+}
+//# sourceMappingURL=ConfigCommands.js.map

package/build/dist/Commands/ConfigCommands.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigCommands.js","sourceRoot":"","sources":["../../../Commands/ConfigCommands.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAOA,wDAoIC;AA1ID,qEAAuD;AAEvD,6DAA8E;AAC9E,4DAA+B;AAC/B,kDAA0B;AAE1B,SAAgB,sBAAsB,CAAC,OAAgB;IACrD,gBAAgB;IAChB,MAAM,QAAQ,GAAY,OAAO;SAC9B,OAAO,CAAC,OAAO,CAAC;SAChB,WAAW,CAAC,wCAAwC,CAAC;SACrD,QAAQ,CAAC,WAAW,EAAE,4BAA4B,CAAC;SACnD,QAAQ,CACP,gBAAgB,EAChB,qDAAqD,CACtD;SACA,MAAM,CAAC,uBAAuB,EAAE,uBAAuB,EAAE,SAAS,CAAC;SACnE,MAAM,CACL,CACE,MAAc,EACd,WAAmB,EACnB,OAAgC,EAChC,EAAE;QACF,IAAI,CAAC;YACH,MAAM,OAAO,GAAe;gBAC1B,IAAI,EAAE,OAAO,CAAC,WAAW;gBACzB,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;gBACvC,MAAM,EAAE,MAAM;aACf,CAAC;YAEF,aAAa,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YAClC,aAAa,CAAC,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAE9C,IAAA,8BAAY,EACV,oCAAoC,OAAO,CAAC,IAAI,kBAAkB,CACnE,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAA,4BAAU,EACR,iBAAiB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAC1E,CAAC;YACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC,CACF,CAAC;IAEJ,uEAAuE;IACvE,KAAK,QAAQ,CAAC;IAEd,mBAAmB;IACnB,MAAM,UAAU,GAAY,OAAO;SAChC,OAAO,CAAC,SAAS,CAAC;SAClB,WAAW,CAAC,6CAA6C,CAAC,CAAC;IAE9D,UAAU;SACP,OAAO,CAAC,MAAM,CAAC;SACf,WAAW,CAAC,8BAA8B,CAAC;SAC3C,MAAM,CAAC,GAAG,EAAE;QACX,MAAM,QAAQ,GACZ,aAAa,CAAC,YAAY,EAAE,CAAC;QAE/B,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1B,IAAA,2BAAS,EACP,8DAA8D,CAC/D,CAAC;YACF,OAAO;QACT,CAAC;QAED,MAAM,OAAO,GACX,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,SAAS;YACrC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAEtC,MAAM,KAAK,GAAgB,IAAI,oBAAK,CAAC;YACnC,IAAI,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAS,EAAE,EAAE;gBAC1C,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,eAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACrC,CAAC,CAAC;YACF,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;SAChC,CAAC,CAAC;QAEH,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC3B,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;QAC/D,CAAC;QAED,sCAAsC;QACtC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEL,UAAU;SACP,OAAO,CAAC,YAAY,CAAC;SACrB,WAAW,CAAC,+BAA+B,CAAC;SAC5C,MAAM,CAAC,CAAC,IAAY,EAAE,EAAE;QACvB,IAAI,CAAC;YACH,aAAa,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;YACtC,IAAA,8BAAY,EAAC,wBAAwB,IAAI,IAAI,CAAC,CAAC;QACjD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAA,4BAAU,EAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACnE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC,CAAC,CAAC;IAEL,UAAU;SACP,OAAO,CAAC,SAAS,CAAC;SAClB,WAAW,CAAC,iCAAiC,CAAC;SAC9C,MAAM,CAAC,GAAG,EAAE;QACX,MAAM,GAAG,GAAsB,aAAa,CAAC,iBAAiB,EAAE,CAAC;QACjE,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,IAAA,2BAAS,EACP,8DAA8D,CAC/D,CAAC;YACF,OAAO;QACT,CAAC;QAED,MAAM,SAAS,GACb,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;YACnB,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC;gBAC1B,MAAM;gBACN,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;YAC7C,CAAC,CAAC,MAAM,CAAC;QAEb,sCAAsC;QACtC,OAAO,CAAC,GAAG,CAAC,YAAY,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;QACpC,sCAAsC;QACtC,OAAO,CAAC,GAAG,CAAC,YAAY,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;QACtC,sCAAsC;QACtC,OAAO,CAAC,GAAG,CAAC,YAAY,SAAS,EAAE,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEL,UAAU;SACP,OAAO,CAAC,eAAe,CAAC;SACxB,WAAW,CAAC,kBAAkB,CAAC;SAC/B,MAAM,CAAC,CAAC,IAAY,EAAE,EAAE;QACvB,IAAI,CAAC;YACH,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAClC,IAAA,8BAAY,EAAC,YAAY,IAAI,YAAY,CAAC,CAAC;QAC7C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAA,4BAAU,EAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACnE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC,CAAC,CAAC;AACP,CAAC"}