@guard-sdk/cli API

This spec is generated from package entry exports and updates on every website build.

Need package context first? Visit @guard-sdk/cli package docs.

Exported Symbols

Kind Name Source
const VALID_STATUSES entry
type ReportCommandOptions entry
function parseReportArgs entry
function formatUsageReport entry
const REPORT_USAGE entry
function runCli entry

Export Declarations

export const VALID_STATUSES = ["success", "failed", "blocked", "timeout"] as const;
export type ReportCommandOptions = { dbPath: string;
export function parseReportArgs(args: string[]): ReportCommandOptions { const filters: UsageReportFilters = {};
export function formatUsageReport(summary: UsageReportSummary): string { const cost = summary.totalEstimatedCostUsd.toFixed(6);
export const REPORT_USAGE = [ "Usage:", " guard report --db <path> [--from <ISO8601>] [--to <ISO8601>] [--name <runName>] [--status <success|failed|blocked|timeout>] [--table <tableName>] [--json]", ].join("\n");
export async function runCli(argv: string[], io: CliIo): Promise<number> { const [command, ...rest] = argv;

JSON Spec

{
  "package": "@guard-sdk/cli",
  "version": "0.5.0",
  "exports": [
    {
      "kind": "const",
      "name": "VALID_STATUSES",
      "source": null
    },
    {
      "kind": "type",
      "name": "ReportCommandOptions",
      "source": null
    },
    {
      "kind": "function",
      "name": "parseReportArgs",
      "source": null
    },
    {
      "kind": "function",
      "name": "formatUsageReport",
      "source": null
    },
    {
      "kind": "const",
      "name": "REPORT_USAGE",
      "source": null
    },
    {
      "kind": "function",
      "name": "runCli",
      "source": null
    }
  ]
}