@akropolys/cli 1.6.0 → 1.6.1

package/README.md

@@ -0,0 +1,45 @@
+# @akropolys/cli
+
+Command-line utilities for [Akropolys](https://akropolys.cloud): scaffold local config, check connectivity, and lint catalog payloads before you ingest them.
+
+## Install
+
+```bash
+npm install -g @akropolys/cli
+# or run on demand
+npx @akropolys/cli <command>
+```
+
+## Commands
+
+### `akropolys init`
+
+Interactively writes an `.env` with your site credentials:
+
+```
+NEXT_PUBLIC_AKROPOLYS_SITE_ID=...
+NEXT_PUBLIC_AKROPOLYS_API_TOKEN=...
+```
+
+### `akropolys doctor`
+
+Verifies your local config and that the API is reachable. Reads `NEXT_PUBLIC_AKROPOLYS_*` or `VITE_AKROPOLYS_*` from `.env` / `.env.local`.
+
+```bash
+akropolys doctor        # health check
+akropolys doctor -v     # also print the resolved config
+```
+
+### `akropolys inspect [file]`
+
+Statically checks a catalog JSON payload for ingestion issues — missing stable identifier, sparse attributes — before you push it.
+
+```bash
+akropolys inspect catalog.json
+cat catalog.json | akropolys inspect --stdin
+akropolys inspect catalog.json --strict   # exit 3 if any warning fires
+```
+
+## License
+
+MIT

package/dist/index.js

@@ -209,9 +209,41 @@ async function runInspect(filePath, options) {
   process.exit(0);
 }
 
+// package.json
+var package_default = {
+  name: "@akropolys/cli",
+  version: "1.6.1",
+  description: "Akropolys CLI \u2014 diagnostic, workspace setup, and payload inspection utility.",
+  license: "MIT",
+  publishConfig: {
+    access: "public"
+  },
+  main: "dist/index.js",
+  bin: {
+    akropolys: "dist/index.js"
+  },
+  files: [
+    "dist",
+    "README.md"
+  ],
+  scripts: {
+    build: "tsup",
+    dev: "tsup --watch"
+  },
+  dependencies: {
+    commander: "^12.0.0",
+    picocolors: "^1.0.0"
+  },
+  devDependencies: {
+    tsup: "^8.0.0",
+    typescript: "^5.0.0",
+    "@types/node": "^20.0.0"
+  }
+};
+
 // src/index.ts
 var program = new import_commander.Command();
-program.name("akropolys").description("Akropolys Command Line Tool \u2014 Developer diagnostics, setup helper, and structural inspector.").version("1.0.0");
+program.name("akropolys").description("Akropolys Command Line Tool \u2014 Developer diagnostics, setup helper, and structural inspector.").version(package_default.version);
 program.command("init").description("Configure the local workspace by generating a default .env file template.").action(async () => {
   await runInit();
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akropolys/cli",
-  "version": "1.6.0",
+  "version": "1.6.1",
   "description": "Akropolys CLI — diagnostic, workspace setup, and payload inspection utility.",
   "license": "MIT",
   "publishConfig": {
@@ -10,10 +10,10 @@
   "bin": {
     "akropolys": "dist/index.js"
   },
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch"
-  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
   "dependencies": {
     "commander": "^12.0.0",
     "picocolors": "^1.0.0"
@@ -22,5 +22,9 @@
     "tsup": "^8.0.0",
     "typescript": "^5.0.0",
     "@types/node": "^20.0.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch"
   }
-}
+}

package/src/commands/doctor.ts

@@ -1,84 +0,0 @@
-import fs from 'fs';
-import pc from 'picocolors';
-
-export function loadEnv() {
-  const envPaths = ['.env', '.env.local'];
-  for (const envPath of envPaths) {
-    if (fs.existsSync(envPath)) {
-      const content = fs.readFileSync(envPath, 'utf-8');
-      const lines = content.split(/\r?\n/);
-      for (const line of lines) {
-        const trimmed = line.trim();
-        if (!trimmed || trimmed.startsWith('#')) continue;
-        const eqIdx = trimmed.indexOf('=');
-        if (eqIdx > 0) {
-          const key = trimmed.substring(0, eqIdx).trim();
-          const value = trimmed.substring(eqIdx + 1).trim().replace(/^['"]|['"]$/g, '');
-          if (key) {
-            process.env[key] = value;
-          }
-        }
-      }
-    }
-  }
-}
-
-export async function runDoctor(options: { verbose?: boolean }) {
-  console.log(pc.bold('\nAkropolys Doctor'));
-  console.log(pc.dim('─────────────────────────'));
-
-  loadEnv();
-
-  const siteId = process.env.NEXT_PUBLIC_AKROPOLYS_SITE_ID || process.env.VITE_AKROPOLYS_SITE_ID || '';
-  const apiToken = process.env.NEXT_PUBLIC_AKROPOLYS_API_TOKEN || process.env.VITE_AKROPOLYS_API_TOKEN || '';
-  const apiUrl = process.env.NEXT_PUBLIC_AKROPOLYS_API_URL || process.env.VITE_AKROPOLYS_API_URL || 'https://api.akropolys.cloud/v1';
-
-  if (options.verbose) {
-    console.log(pc.dim(`[Verbose] Site ID: ${siteId || '<not set>'}`));
-    console.log(pc.dim(`[Verbose] API Token: ${apiToken ? '********' : '<not set>'}`));
-    console.log(pc.dim(`[Verbose] API URL: ${apiUrl}`));
-  }
-
-  // 1. Configuration check
-  if (!siteId) {
-    console.log(pc.red('❌ Configuration: Site ID is missing. Set NEXT_PUBLIC_AKROPOLYS_SITE_ID in your env.'));
-    process.exit(1);
-  }
-  console.log(pc.green(`✓ Configuration: Site ID detected (${siteId})`));
-
-  if (!apiToken) {
-    console.log(pc.red('❌ Environment: API Token is missing. Set NEXT_PUBLIC_AKROPOLYS_API_TOKEN in your env.'));
-    process.exit(1);
-  }
-  console.log(pc.green('✓ Environment: API Token detected'));
-
-  // 2. Connectivity check
-  const start = Date.now();
-  try {
-    const res = await fetch(`${apiUrl}/health`, {
-      method: 'GET',
-      headers: {
-        'X-Akropolys-Token': apiToken,
-        'X-Akropolys-Site': siteId,
-      },
-    }).catch(err => {
-      // Throw fetch failures
-      throw new Error(`Fetch failed: ${err.message}`);
-    });
-
-    const duration = Date.now() - start;
-
-    if (!res.ok) {
-      console.log(pc.red(`❌ Connection: API responded with status ${res.status} (Ping: ${duration}ms)`));
-      process.exit(2);
-    }
-
-    console.log(pc.green(`✓ Connection: Successfully connected to ${apiUrl} (ping: ${duration}ms)`));
-
-    console.log(pc.bold(pc.green('\nStatus: Healthy (All configuration and connectivity checks passed)')));
-    process.exit(0);
-  } catch (err: any) {
-    console.log(pc.red(`❌ Connection: Unreachable API at ${apiUrl}. Error: ${err.message}`));
-    process.exit(2);
-  }
-}

package/src/commands/init.ts

@@ -1,38 +0,0 @@
-import readline from 'readline';
-import fs from 'fs';
-import pc from 'picocolors';
-
-const question = (rl: readline.Interface, query: string): Promise<string> => {
-  return new Promise((resolve) => rl.question(query, resolve));
-};
-
-export async function runInit() {
-  console.log(pc.bold(pc.cyan('\nConfiguring Akropolys Workspace...')));
-  console.log(pc.dim('─────────────────────────'));
-
-  const rl = readline.createInterface({
-    input: process.stdin,
-    output: process.stdout,
-  });
-
-  try {
-    const siteId = await question(rl, pc.cyan('? Enter your Akropolys Site ID: '));
-    const apiToken = await question(rl, pc.cyan('? Enter your Akropolys API Token: '));
-
-    // apiUrl is optional — the SDK defaults to the shared managed backend
-    // (https://api.akropolys.cloud/v1). Only self-hosted/local dev needs to set it.
-    const envContent = `NEXT_PUBLIC_AKROPOLYS_SITE_ID=${siteId.trim()}
-NEXT_PUBLIC_AKROPOLYS_API_TOKEN=${apiToken.trim()}
-`;
-
-    fs.writeFileSync('.env', envContent, 'utf-8');
-    console.log(pc.dim('\n─────────────────────────'));
-    console.log(pc.green('✓ Generated .env with configuration parameters.'));
-    console.log(pc.green('✓ Saved config template.'));
-  } catch (err: any) {
-    console.error(pc.red(`\n❌ Error generating configuration: ${err.message}`));
-    process.exit(1);
-  } finally {
-    rl.close();
-  }
-}

package/src/commands/inspect.ts

@@ -1,100 +0,0 @@
-import fs from 'fs';
-import pc from 'picocolors';
-
-function readStdin(): Promise<string> {
-  return new Promise((resolve, reject) => {
-    let data = '';
-    process.stdin.setEncoding('utf-8');
-    process.stdin.on('readable', () => {
-      let chunk;
-      while ((chunk = process.stdin.read()) !== null) {
-        data += chunk;
-      }
-    });
-    process.stdin.on('end', () => {
-      resolve(data);
-    });
-    process.stdin.on('error', (err) => {
-      reject(err);
-    });
-  });
-}
-
-export async function runInspect(
-  filePath: string | undefined,
-  options: { stdin?: boolean; strict?: boolean }
-) {
-  console.log(pc.bold('\nAkropolys Inspect'));
-  console.log(pc.dim('─────────────────────────'));
-
-  let rawData = '';
-
-  // 1. Read input
-  try {
-    if (options.stdin || (!filePath && !process.stdin.isTTY)) {
-      rawData = await readStdin();
-    } else if (filePath) {
-      if (!fs.existsSync(filePath)) {
-        console.error(pc.red(`❌ Error: File not found at "${filePath}"`));
-        process.exit(1);
-      }
-      rawData = fs.readFileSync(filePath, 'utf-8');
-    } else {
-      console.error(pc.red('❌ Error: Provide a file path or pipe via standard input using --stdin'));
-      process.exit(1);
-    }
-  } catch (err: any) {
-    console.error(pc.red(`❌ Error reading input: ${err.message}`));
-    process.exit(1);
-  }
-
-  // 2. Parse JSON
-  let items: any[] = [];
-  try {
-    const parsed = JSON.parse(rawData.trim());
-    items = Array.isArray(parsed) ? parsed : [parsed];
-  } catch (err: any) {
-    console.error(pc.red(`❌ Error parsing JSON: Invalid JSON structure. ${err.message}`));
-    process.exit(1);
-  }
-
-  console.log(pc.cyan(`Parsed ${items.length} catalog items.`));
-  console.log(pc.dim('\nIngestion Quality Diagnostics:'));
-
-  let warningsCount = 0;
-
-  // 3. Scan items against Registry Rules
-  items.forEach((item, index) => {
-    const identifier = item.id || item.productId || item.slug || item.url || item.name || `item at index ${index}`;
-    
-    // AP001: Missing Stable Identifier
-    const hasId = item.id !== undefined && item.id !== null && item.id !== '';
-    const hasProductId = item.productId !== undefined && item.productId !== null && item.productId !== '';
-    const hasSlug = item.slug !== undefined && item.slug !== null && item.slug !== '';
-    const hasUrl = item.url !== undefined && item.url !== null && item.url !== '';
-    const hasName = item.name !== undefined && item.name !== null && item.name !== '';
-
-    if (!hasId && !hasProductId && !hasSlug && !hasUrl && !hasName) {
-      console.log(`  ${pc.yellow('⚠')} [AP001] Missing Stable Identifier: "${identifier}" ➔ Deduplication & correlation unavailable`);
-      warningsCount++;
-    }
-
-    // AP002: Low-Signal Payload (sparse payload: fewer than 2 keys, or only identifier is defined)
-    const keysCount = Object.keys(item).length;
-    if (keysCount < 2) {
-      console.log(`  ${pc.yellow('⚠')} [AP002] Low-Signal Payload: "${identifier}" has sparse attributes ➔ Search vector quality reduced`);
-      warningsCount++;
-    }
-  });
-
-  console.log(pc.dim('\n─────────────────────────'));
-  console.log(pc.bold(`Inspect complete: ${items.length} items checked, ${warningsCount} warnings flagged.`));
-
-  // 4. Exit codes: strict vs non-strict
-  if (warningsCount > 0 && options.strict) {
-    console.log(pc.red('Exit code 3: strict mode failed due to warnings.'));
-    process.exit(3);
-  }
-
-  process.exit(0);
-}

package/src/index.ts

@@ -1,38 +0,0 @@
-import { Command } from 'commander';
-import { runInit } from './commands/init';
-import { runDoctor } from './commands/doctor';
-import { runInspect } from './commands/inspect';
-
-const program = new Command();
-
-program
-  .name('akropolys')
-  .description('Akropolys Command Line Tool — Developer diagnostics, setup helper, and structural inspector.')
-  .version('1.0.0');
-
-program
-  .command('init')
-  .description('Configure the local workspace by generating a default .env file template.')
-  .action(async () => {
-    await runInit();
-  });
-
-program
-  .command('doctor')
-  .description('Perform a health check consolidating local configuration values and backend API reachability.')
-  .option('-v, --verbose', 'Include verbose logs and configuration dumps.')
-  .action(async (options) => {
-    await runDoctor(options);
-  });
-
-program
-  .command('inspect')
-  .description('Statically inspect a catalog payload file or stream against the Akropolys Anti-Pattern Registry.')
-  .argument('[file]', 'Path to the local catalog JSON file.')
-  .option('--stdin', 'Force reading data from standard input.')
-  .option('--strict', 'Fail the process (exit code 3) if any structural registry warnings are triggered.')
-  .action(async (file, options) => {
-    await runInspect(file, options);
-  });
-
-program.parse(process.argv);

package/tsconfig.json

@@ -1,13 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2022",
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext",
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "skipLibCheck": true,
-    "outDir": "./dist"
-  },
-  "include": ["src/**/*"]
-}

package/tsup.config.ts

@@ -1,11 +0,0 @@
-import { defineConfig } from 'tsup';
-
-export default defineConfig({
-  entry: ['src/index.ts'],
-  format: ['cjs'],
-  clean: true,
-  dts: false,
-  banner: {
-    js: '#!/usr/bin/env node',
-  },
-});