@jcit/signoz 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 just-cli-it contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/cli.d.mts

@@ -0,0 +1 @@
+

package/dist/cli.d.ts

@@ -0,0 +1 @@
+

package/dist/cli.mjs

@@ -0,0 +1,136 @@
+#!/usr/bin/env node
+import { formatOutput, addExamples, credential, installErrorHandler, defineCliApp } from '@jcit/core';
+import { c as createSignozClient } from './shared/signoz.DH9MeMIj.mjs';
+import { consola } from 'consola';
+import { readFileSync } from 'node:fs';
+
+function registerAlerts(program) {
+  const cmd = program.command("alerts").description("List all alert rules").option("--format <format>", "Output format: json | table | text", "text").option("--url <url>", "SigNoz API base URL").option("--token <token>", "SigNoz API token").action(async (opts) => {
+    const client = createSignozClient({ url: opts.url, token: opts.token });
+    const alerts = await client("/api/v1/rules");
+    formatOutput(alerts, opts.format);
+  });
+  addExamples(cmd, ["signoz alerts", "signoz alerts --format json"]);
+}
+
+const SERVICE = "signoz";
+function registerAuth(program) {
+  const auth = program.command("auth").description("Manage SigNoz authentication");
+  const login = auth.command("login").description("Store SigNoz credentials in system keychain").option("--url <url>", "SigNoz API base URL").option("--token <token>", "SigNoz API token").action(async (opts) => {
+    const url = opts.url ?? await consola.prompt("SigNoz API base URL:", { type: "text" });
+    const token = opts.token ?? await consola.prompt("SigNoz API token:", { type: "text", style: "password" });
+    credential.store(SERVICE, "url", url);
+    credential.store(SERVICE, "token", token);
+    consola.success("Credentials stored in system keychain.");
+  });
+  addExamples(login, [
+    "signoz auth login",
+    "signoz auth login --url https://signoz.example.com --token my-api-key"
+  ]);
+  auth.command("logout").description("Remove stored SigNoz credentials").action(() => {
+    credential.delete(SERVICE, "url");
+    credential.delete(SERVICE, "token");
+    consola.success("Credentials removed.");
+  });
+}
+
+const DURATION_RE = /^(\d+)(s|m|h|d)$/;
+const UNITS = {
+  s: 1e3,
+  m: 6e4,
+  h: 36e5,
+  d: 864e5
+};
+function parseDuration(input) {
+  const match = input.match(DURATION_RE);
+  if (!match) throw new Error(`Invalid duration: "${input}". Use format like 1h, 30m, 7d`);
+  return Number(match[1]) * UNITS[match[2]];
+}
+function parseSince(input) {
+  if (DURATION_RE.test(input)) {
+    return Date.now() - parseDuration(input);
+  }
+  const ts = new Date(input).getTime();
+  if (Number.isNaN(ts)) throw new Error(`Invalid time: "${input}"`);
+  return ts;
+}
+function parseUntil(input) {
+  if (input === "now") return Date.now();
+  return parseSince(input);
+}
+
+function buildPromqlRequest(query, start, end, step) {
+  return {
+    start,
+    end,
+    compositeQuery: {
+      queries: [{ type: "promql", spec: { name: "A", query, step } }]
+    }
+  };
+}
+function buildSqlRequest(query, start, end) {
+  return {
+    start,
+    end,
+    compositeQuery: {
+      queries: [{ type: "clickhouse_sql", spec: { name: "A", query, disabled: false } }]
+    }
+  };
+}
+function registerQuery(program) {
+  const cmd = program.command("query").description("Query traces, logs, and metrics via the unified query API").option("--promql <expr>", "PromQL expression").option("--sql <query>", "ClickHouse SQL query").option("-f, --file <path>", "Load query from JSON file (v5 query_range format)").option("--since <duration>", "Start time: duration (1h, 30m, 7d) or ISO date", "1h").option("--until <time>", "End time: 'now', duration, or ISO date", "now").option("--step <seconds>", "Step interval in seconds (PromQL time series)", "60").option("--format <format>", "Output format: json | table | text", "json").option("--url <url>", "SigNoz API base URL").option("--token <token>", "SigNoz API token").action(async (opts) => {
+    const modes = [opts.promql, opts.sql, opts.file].filter(Boolean);
+    if (modes.length === 0) {
+      cmd.error("specify one of --promql, --sql, or --file");
+    }
+    if (modes.length > 1) {
+      cmd.error("specify only one of --promql, --sql, or --file");
+    }
+    const client = createSignozClient({ url: opts.url, token: opts.token });
+    const start = parseSince(opts.since);
+    const end = parseUntil(opts.until);
+    let body;
+    if (opts.promql) {
+      body = buildPromqlRequest(opts.promql, start, end, Number(opts.step));
+    } else if (opts.sql) {
+      body = buildSqlRequest(opts.sql, start, end);
+    } else {
+      body = JSON.parse(readFileSync(opts.file, "utf-8"));
+      body.start = start;
+      body.end = end;
+    }
+    const result = await client("/api/v5/query_range", {
+      method: "POST",
+      body
+    });
+    formatOutput(result, opts.format);
+  });
+  addExamples(cmd, [
+    "signoz query --promql 'rate(http_requests_total[5m])' --since 1h",
+    "signoz query --sql 'SELECT count() FROM signoz_logs.distributed_logs' --since 24h",
+    "signoz query -f my-query.json --since 7d --until 1d",
+    "signoz query --promql 'up' --format table"
+  ]);
+}
+
+function registerServices(program) {
+  const cmd = program.command("services").description("List all SigNoz services").option("--format <format>", "Output format: json | table | text", "text").option("--url <url>", "SigNoz API base URL").option("--token <token>", "SigNoz API token").action(async (opts) => {
+    const client = createSignozClient({ url: opts.url, token: opts.token });
+    const services = await client("/api/v1/services/list");
+    formatOutput(services, opts.format);
+  });
+  addExamples(cmd, ["signoz services", "signoz services --format json"]);
+}
+
+installErrorHandler();
+const program = defineCliApp({
+  name: "signoz",
+  version: "0.0.1",
+  description: "CLI for SigNoz observability platform",
+  docsUrl: "https://github.com/m1heng/just-cli-it/tree/main/packages/signoz"
+});
+registerAuth(program);
+registerQuery(program);
+registerAlerts(program);
+registerServices(program);
+program.parseAsync();

package/dist/index.d.mts

@@ -0,0 +1,10 @@
+import * as ofetch from 'ofetch';
+
+interface SignozAuthOptions {
+    url?: string;
+    token?: string;
+}
+declare function createSignozClient(opts?: SignozAuthOptions): <T>(path: string, fetchOptions?: Parameters<ofetch.$Fetch>[1]) => Promise<T>;
+
+export { createSignozClient };
+export type { SignozAuthOptions };

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import * as ofetch from 'ofetch';
+
+interface SignozAuthOptions {
+    url?: string;
+    token?: string;
+}
+declare function createSignozClient(opts?: SignozAuthOptions): <T>(path: string, fetchOptions?: Parameters<ofetch.$Fetch>[1]) => Promise<T>;
+
+export { createSignozClient };
+export type { SignozAuthOptions };

package/dist/index.mjs

@@ -0,0 +1,3 @@
+export { c as createSignozClient } from './shared/signoz.DH9MeMIj.mjs';
+import '@jcit/core';
+import 'consola';

package/dist/shared/signoz.DH9MeMIj.mjs

@@ -0,0 +1,18 @@
+import { credential, createApiClient } from '@jcit/core';
+import { consola } from 'consola';
+
+const SERVICE = "signoz";
+const DEFAULT_BASE_URL = "http://localhost:3301";
+function createSignozClient(opts = {}) {
+  const baseURL = credential.resolve(SERVICE, "url", { flag: opts.url, envVar: "SIGNOZ_URL" }) ?? DEFAULT_BASE_URL;
+  const token = credential.resolve(SERVICE, "token", { flag: opts.token, envVar: "SIGNOZ_TOKEN" }) ?? "";
+  if (!token) {
+    consola.warn("No API token configured. Run 'signoz auth login' or pass --token.");
+  }
+  return createApiClient({
+    baseURL,
+    headers: token ? { "SIGNOZ-API-KEY": token } : {}
+  });
+}
+
+export { createSignozClient as c };

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@jcit/signoz",
+  "version": "0.1.0",
+  "description": "CLI for SigNoz observability platform",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/m1heng/just-cli-it.git",
+    "directory": "packages/signoz"
+  },
+  "type": "module",
+  "bin": {
+    "signoz": "./dist/cli.mjs"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.mts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "commander": "^14.0.0",
+    "consola": "^3.4.0",
+    "@jcit/core": "0.1.0"
+  },
+  "devDependencies": {
+    "unbuild": "^3.3.1"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "dev": "unbuild --stub"
+  }
+}