@blkc-code/cli 0.1.0 → 0.1.2

package/src/commands/logbook.ts

@@ -0,0 +1,194 @@
+/**
+ * BLKC CLI - Logbook Commands
+ * 
+ * Commands for working with BLKC Logbook.
+ * 
+ * @package @blkc-code/cli
+ * @license Apache-2.0
+ * @author Black Code Enterprises LLC
+ */
+
+import { Command } from "commander";
+import chalk from "chalk";
+import ora from "ora";
+import { stat } from "node:fs/promises";
+import path from "node:path";
+import { Logbook, verifyLogbook, readLogbook, LogbookVerificationResult } from "@blkc-code/logbook";
+
+// ============================================================================
+// Command: logbook verify
+// ============================================================================
+
+function setupVerifyCommand(program: Command): void {
+  program
+    .command("verify <file-path>")
+    .description("Verify Logbook chain integrity")
+    .option("--algorithm <algo>", "Hash algorithm", "sha256")
+    .action(async (filePath: string, options: { algorithm: string }) => {
+      const spinner = ora("Verifying Logbook...").start();
+      
+      try {
+        const absolutePath = path.resolve(process.cwd(), filePath);
+        
+        // Check if file exists
+        try {
+          await stat(absolutePath);
+        } catch {
+          spinner.fail(`File not found: ${absolutePath}`);
+          process.exit(1);
+        }
+        
+        const result: LogbookVerificationResult = await verifyLogbook(absolutePath, options.algorithm);
+        
+        if (result.valid) {
+          spinner.succeed("Logbook verification passed");
+          console.log(chalk.green("\n✓ Chain is valid"));
+          console.log(chalk.gray(`  Entries: ${result.entries.length}`));
+          console.log(chalk.gray(`  Last hash: ${result.lastHash?.substring(0, 16)}...`));
+        } else {
+          spinner.fail("Logbook verification failed");
+          console.error(chalk.red("\n✗ Chain is invalid"));
+          console.error(chalk.red(`  Issues: ${result.issues.length}`));
+          
+          for (const issue of result.issues) {
+            console.error(chalk.red(`\n  Entry ${issue.index}:`));
+            console.error(chalk.red(`    ${issue.message}`));
+          }
+          
+          process.exit(1);
+        }
+      } catch (error) {
+        spinner.fail(`Failed to verify: ${error}`);
+        process.exit(1);
+      }
+    });
+}
+
+// ============================================================================
+// Command: logbook check
+// ============================================================================
+
+function setupCheckCommand(program: Command): void {
+  program
+    .command("check <file-path>")
+    .description("Check Logbook for issues (alias for verify)")
+    .action(async (filePath: string) => {
+      // Delegate to verify
+      const verifyCmd = program.commands.find((c) => c.name() === "verify");
+      if (verifyCmd) {
+        await (verifyCmd.action as unknown as (filePath: string, options: Record<string, unknown>) => Promise<void>)(filePath, {});
+      }
+    });
+}
+
+// ============================================================================
+// Command: logbook info
+// ============================================================================
+
+function setupInfoCommand(program: Command): void {
+  program
+    .command("info <file-path>")
+    .description("Show Logbook information")
+    .action(async (filePath: string) => {
+      const spinner = ora("Loading Logbook info...").start();
+      
+      try {
+        const absolutePath = path.resolve(process.cwd(), filePath);
+        
+        // Check if file exists
+        try {
+          await stat(absolutePath);
+        } catch {
+          spinner.fail(`File not found: ${absolutePath}`);
+          process.exit(1);
+        }
+        
+        const logbook = new Logbook({ filePath: absolutePath });
+        const info = await logbook.info();
+        
+        spinner.succeed(`Logbook: ${info.filePath}`);
+        
+        console.log(chalk.bold("\nLogbook Information"));
+        console.log(chalk.gray("─".repeat(40)));
+        console.log(chalk.gray(`File:          ${info.filePath}`));
+        console.log(chalk.gray(`Entry count:   ${info.entryCount}`));
+        
+        if (info.firstEntry) {
+          console.log(chalk.gray(`\nFirst Entry:`));
+          console.log(chalk.gray(`  Timestamp:    ${info.firstEntry.timestamp}`));
+          console.log(chalk.gray(`  Actor:        ${info.firstEntry.actor.name}`));
+          console.log(chalk.gray(`  Event:        ${info.firstEntry.event}`));
+        }
+        
+        if (info.lastEntry) {
+          console.log(chalk.gray(`\nLast Entry:`));
+          console.log(chalk.gray(`  Timestamp:    ${info.lastEntry.timestamp}`));
+          console.log(chalk.gray(`  Actor:        ${info.lastEntry.actor.name}`));
+          console.log(chalk.gray(`  Event:        ${info.lastEntry.event}`));
+          console.log(chalk.gray(`  Hash:         ${info.lastHash?.substring(0, 16)}...`));
+        }
+      } catch (error) {
+        spinner.fail(`Failed to show info: ${error}`);
+        process.exit(1);
+      }
+    });
+}
+
+// ============================================================================
+// Command: logbook tail
+// ============================================================================
+
+function setupTailCommand(program: Command): void {
+  program
+    .command("tail <file-path>")
+    .description("Show the last N entries from Logbook")
+    .option("--lines <n>", "Number of lines to show", "10")
+    .action(async (filePath: string, options: { lines: string }) => {
+      const spinner = ora("Reading Logbook...").start();
+      
+      try {
+        const absolutePath = path.resolve(process.cwd(), filePath);
+        const lines = parseInt(options.lines, 10) || 10;
+        
+        const entries = await readLogbook(absolutePath);
+        const tailEntries = entries.slice(-lines);
+        
+        spinner.succeed(`Showing last ${tailEntries.length} entries`);
+        
+        for (const entry of tailEntries) {
+          console.log(chalk.gray(`\n[${entry.timestamp}] ${entry.event}`));
+          console.log(chalk.gray(`  Actor: ${entry.actor.name}`));
+          if (entry.subject) {
+            console.log(chalk.gray(`  Subject: ${entry.subject.type}:${entry.subject.id}`));
+          }
+          if (entry.hash) {
+            console.log(chalk.gray(`  Hash: ${entry.hash.substring(0, 16)}...`));
+          }
+        }
+        
+        if (tailEntries.length === 0) {
+          console.log(chalk.gray("\nNo entries found"));
+        }
+      } catch (error) {
+        spinner.fail(`Failed to tail: ${error}`);
+        process.exit(1);
+      }
+    });
+}
+
+// ============================================================================
+// Register Commands
+// ============================================================================
+
+/** Register all logbook commands with the program */
+export function registerLogbookCommands(program: Command): void {
+  const logbookProgram = program
+    .command("logbook")
+    .description("Logbook commands")
+    .alias("l");
+
+  setupVerifyCommand(logbookProgram);
+  setupCheckCommand(logbookProgram);
+  setupInfoCommand(logbookProgram);
+  setupTailCommand(logbookProgram);
+}

package/src/index.ts

@@ -0,0 +1,70 @@
+/**
+ * BLKC CLI - Developer tools for BLKC
+ * 
+ * This package provides command-line tools for working with BLKC Blocks, Kits, Circuits, and Logbook.
+ * 
+ * @package @blkc-code/cli
+ * @version 0.1.0
+ * @license Apache-2.0
+ * @author Black Code Enterprises LLC
+ */
+
+import { Command } from "commander";
+import { registerBlockCommands } from "./commands/block.js";
+import { registerKitCommands } from "./commands/kit.js";
+import { registerCircuitCommands } from "./commands/circuit.js";
+import { registerLogbookCommands } from "./commands/logbook.js";
+import { registerDeployCommands } from "./commands/deploy.js";
+
+/**
+ * The main BLKC CLI program.
+ */
+export const program = new Command();
+
+// Configure the CLI
+program
+  .name("blkc")
+  .description("BLKC developer CLI - Tools for working with Blocks, Kits, Circuits, and Logbook")
+  .version("0.1.0");
+
+// Show help after errors
+program.showHelpAfterError();
+
+// Configure output to prevent duplicate errors
+program.configureOutput({
+  outputError: (str) => {
+    // Only print the error if it's not already been handled
+    if (str && !str.includes("error:")) {
+      console.error(str.trim());
+    }
+  },
+});
+
+// Register all command groups
+registerBlockCommands(program);
+registerKitCommands(program);
+registerCircuitCommands(program);
+registerLogbookCommands(program);
+registerDeployCommands(program);
+
+// Add a global --help flag
+program.option("--debug", "Enable debug mode");
+
+/**
+ * Run the CLI.
+ */
+export async function run(): Promise<void> {
+  try {
+    await program.parseAsync(process.argv);
+  } catch (error) {
+    if (error instanceof Error) {
+      console.error(`Error: ${error.message}`);
+    } else {
+      console.error("An unknown error occurred");
+    }
+    process.exit(1);
+  }
+}
+
+// Export for bin usage
+export default program;

package/dist/utils/filesystem.d.ts

@@ -1,5 +0,0 @@
-export declare const workspacePath: (...segments: string[]) => string;
-export declare const ensureDirectory: (relativePath: string) => Promise<void>;
-export declare const readJsonFile: <T>(relativePath: string) => Promise<T>;
-export declare const writeJsonFile: (relativePath: string, payload: unknown) => Promise<void>;
-export declare const exists: (relativePath: string) => Promise<boolean>;

package/dist/utils/filesystem.js

@@ -1,21 +0,0 @@
-import { readFile, writeFile } from "node:fs/promises";
-import path from "node:path";
-import { ensureDir, pathExists } from "fs-extra";
-export const workspacePath = (...segments) => path.resolve(process.cwd(), ...segments);
-export const ensureDirectory = async (relativePath) => {
-    await ensureDir(workspacePath(relativePath));
-};
-export const readJsonFile = async (relativePath) => {
-    const filePath = workspacePath(relativePath);
-    const contents = await readFile(filePath, { encoding: "utf8" });
-    // Some manifests were written by PowerShell with a UTF-8 BOM, which JSON.parse rejects.
-    return JSON.parse(contents.replace(/^\uFEFF/, ""));
-};
-export const writeJsonFile = async (relativePath, payload) => {
-    const filePath = workspacePath(relativePath);
-    await ensureDir(path.dirname(filePath));
-    const formatted = `${JSON.stringify(payload, null, 2)}\n`;
-    await writeFile(filePath, formatted, { encoding: "utf8" });
-};
-export const exists = async (relativePath) => pathExists(workspacePath(relativePath));
-//# sourceMappingURL=filesystem.js.map

package/dist/utils/filesystem.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"filesystem.js","sourceRoot":"","sources":["../../src/utils/filesystem.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEjD,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,GAAG,QAAkB,EAAE,EAAE,CACrD,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,QAAQ,CAAC,CAAC;AAE3C,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,EAAE,YAAoB,EAAE,EAAE;IAC5D,MAAM,SAAS,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC;AAC/C,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,EAAK,YAAoB,EAAc,EAAE;IACxE,MAAM,QAAQ,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;IAC7C,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;IAChE,wFAAwF;IACxF,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAM,CAAC;AAC1D,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,EAAE,YAAoB,EAAE,OAAgB,EAAE,EAAE;IAC5E,MAAM,QAAQ,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;IAC7C,MAAM,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;IACxC,MAAM,SAAS,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC;IAC1D,MAAM,SAAS,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;AAC7D,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,MAAM,GAAG,KAAK,EAAE,YAAoB,EAAE,EAAE,CACnD,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC"}

package/dist/utils/github.d.ts

@@ -1,23 +0,0 @@
-export type CreateRepoOptions = {
-    org?: string;
-    name: string;
-    description?: string;
-    private?: boolean;
-    token?: string;
-};
-export declare const ensureGithubRepo: (opts: CreateRepoOptions) => Promise<{
-    created: boolean;
-    message: string;
-    repo?: undefined;
-    details?: undefined;
-} | {
-    created: boolean;
-    message: string;
-    repo: any;
-    details?: undefined;
-} | {
-    created: boolean;
-    message: any;
-    details: any;
-    repo?: undefined;
-}>;

package/dist/utils/github.js

@@ -1,66 +0,0 @@
-import https from "node:https";
-import { URL } from "node:url";
-const requestJson = (url, token, body) => new Promise((resolve, reject) => {
-    try {
-        const u = new URL(url);
-        const data = JSON.stringify(body);
-        const headers = {
-            Authorization: token ? `token ${token}` : "",
-            "Content-Type": "application/json",
-            Accept: "application/vnd.github+json",
-            "User-Agent": "blkc-cli",
-            "Content-Length": Buffer.byteLength(data).toString(),
-        };
-        const opts = {
-            method: "POST",
-            hostname: u.hostname,
-            path: u.pathname + (u.search ?? ""),
-            headers,
-        };
-        const req = https.request(opts, (res) => {
-            let raw = "";
-            res.setEncoding("utf8");
-            res.on("data", (chunk) => (raw += chunk));
-            res.on("end", () => {
-                try {
-                    const parsed = raw ? JSON.parse(raw) : {};
-                    resolve({ statusCode: res.statusCode, body: parsed });
-                }
-                catch (err) {
-                    reject(err);
-                }
-            });
-        });
-        req.on("error", (err) => reject(err));
-        req.write(data);
-        req.end();
-    }
-    catch (error) {
-        reject(error);
-    }
-});
-export const ensureGithubRepo = async (opts) => {
-    if (!opts.token) {
-        return { created: false, message: "No GITHUB_TOKEN provided; skipping GitHub repo creation." };
-    }
-    const url = opts.org
-        ? `https://api.github.com/orgs/${opts.org}/repos`
-        : `https://api.github.com/user/repos`;
-    const body = {
-        name: opts.name,
-        description: opts.description ?? "",
-        private: !!opts.private,
-        auto_init: true,
-    };
-    try {
-        const res = await requestJson(url, opts.token, body);
-        if (res.statusCode && res.statusCode >= 200 && res.statusCode < 300) {
-            return { created: true, message: "Repository created", repo: res.body.html_url };
-        }
-        return { created: false, message: res.body?.message || "Failed to create repo", details: res.body };
-    }
-    catch (error) {
-        return { created: false, message: error.message };
-    }
-};
-//# sourceMappingURL=github.js.map

package/dist/utils/github.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"github.js","sourceRoot":"","sources":["../../src/utils/github.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAU/B,MAAM,WAAW,GAAG,CAAC,GAAW,EAAE,KAAyB,EAAE,IAAY,EAAE,EAAE,CAC3E,IAAI,OAAO,CAAM,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;IACnC,IAAI,CAAC;QACH,MAAM,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QACvB,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,OAAO,GAA2B;YACtC,aAAa,EAAE,KAAK,CAAC,CAAC,CAAC,SAAS,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE;YAC5C,cAAc,EAAE,kBAAkB;YAClC,MAAM,EAAE,6BAA6B;YACrC,YAAY,EAAE,UAAU;YACxB,gBAAgB,EAAE,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE;SACrD,CAAC;QAEF,MAAM,IAAI,GAAyB;YACjC,MAAM,EAAE,MAAM;YACd,QAAQ,EAAE,CAAC,CAAC,QAAQ;YACpB,IAAI,EAAE,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC;YACnC,OAAO;SACR,CAAC;QAEF,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE;YACtC,IAAI,GAAG,GAAG,EAAE,CAAC;YACb,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YACxB,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC,CAAC,CAAC;YAC1C,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;gBACjB,IAAI,CAAC;oBACH,MAAM,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC1C,OAAO,CAAC,EAAE,UAAU,EAAE,GAAG,CAAC,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;gBACxD,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,MAAM,CAAC,GAAG,CAAC,CAAC;gBACd,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;QACtC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAChB,GAAG,CAAC,GAAG,EAAE,CAAC;IACZ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,KAAK,CAAC,CAAC;IAChB,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,EAAE,IAAuB,EAAE,EAAE;IAChE,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;QAChB,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,0DAA0D,EAAE,CAAC;IACjG,CAAC;IAED,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG;QAClB,CAAC,CAAC,+BAA+B,IAAI,CAAC,GAAG,QAAQ;QACjD,CAAC,CAAC,mCAAmC,CAAC;IAExC,MAAM,IAAI,GAAG;QACX,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,WAAW,EAAE,IAAI,CAAC,WAAW,IAAI,EAAE;QACnC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO;QACvB,SAAS,EAAE,IAAI;KAChB,CAAC;IAEF,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACrD,IAAI,GAAG,CAAC,UAAU,IAAI,GAAG,CAAC,UAAU,IAAI,GAAG,IAAI,GAAG,CAAC,UAAU,GAAG,GAAG,EAAE,CAAC;YACpE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,oBAAoB,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACnF,CAAC;QAED,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,IAAI,EAAE,OAAO,IAAI,uBAAuB,EAAE,OAAO,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC;IACtG,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAG,KAAe,CAAC,OAAO,EAAE,CAAC;IAC/D,CAAC;AACH,CAAC,CAAC"}