@aiready/cli 0.14.7 → 0.14.9

package/src/cli.ts

@@ -49,15 +49,17 @@ AI READINESS SCORING:
 EXAMPLES:
   $ aiready scan                          # Comprehensive analysis with AI Readiness Score
   $ aiready scan --no-score               # Run scan without score calculation
-  $ aiready scan --tools patterns         # Run only pattern detection
+  $ aiready init                          # Create a default aiready.json configuration
+  $ aiready init --full                   # Create configuration with ALL available options
   $ npx @aiready/cli scan                 # Industry standard way to run standard scan
   $ aiready scan --output json            # Output raw JSON for piping
 
 GETTING STARTED:
-  1. Run 'aiready scan' to analyze your codebase and get an AI Readiness Score
-  2. Use '--profile agentic' for agent-focused analysis
-  3. Create aiready.json for persistent configuration
-  4. Set up CI/CD with '--threshold' for quality gates
+  1. Run 'aiready init' to create a persistent 'aiready.json' config file
+  2. Run 'aiready scan' to analyze your codebase and get an AI Readiness Score
+  3. Use 'aiready init --full' to see every fine-tuning parameter available
+  4. Use '--profile agentic' for agent-focused analysis
+  5. Set up CI/CD with '--threshold' for quality gates
 
 CONFIGURATION:
   Config files (searched upward): aiready.json, .aiready.json, aiready.config.*

package/src/commands/report-formatter.ts

@@ -8,7 +8,10 @@ import {
 } from '@aiready/core';
 
 /**
- * Handle console output for the scan results
+ * Handle console output for the scan results.
+ *
+ * @param results - The combined results from all tools.
+ * @param startTime - The timestamp when the scan started.
  */
 export function printScanSummary(results: any, startTime: number) {
   console.log(chalk.cyan('\n=== AIReady Run Summary ==='));
@@ -21,7 +24,10 @@ export function printScanSummary(results: any, startTime: number) {
 }
 
 /**
- * Print business impact analysis
+ * Print business impact analysis based on ROI and budget metrics.
+ *
+ * @param roi - Calculated Return on Investment metrics.
+ * @param unifiedBudget - Consolidated context budget metrics.
  */
 export function printBusinessImpact(roi: any, unifiedBudget: any) {
   console.log(chalk.bold('\n💰 Business Impact Analysis (Monthly)'));
@@ -40,7 +46,10 @@ export function printBusinessImpact(roi: any, unifiedBudget: any) {
 }
 
 /**
- * Print detailed scoring breakdown
+ * Print detailed scoring breakdown by tool.
+ *
+ * @param scoringResult - The overall scoring result.
+ * @param scoringProfile - The name of the scoring profile used.
  */
 export function printScoring(
   scoringResult: ScoringResult,
@@ -87,7 +96,11 @@ export function printScoring(
 }
 
 /**
- * Normalize report mapping (CLI logic)
+ * Normalize and map tool-specific results to a unified report structure.
+ *
+ * @param res - Raw unified results object.
+ * @param scoring - Optional scoring result to include.
+ * @returns Enhanced report with totals and scoring.
  */
 export function mapToUnifiedReport(
   res: any,

package/src/index.ts

@@ -147,8 +147,12 @@ function sanitizeToolConfig(config: any): any {
 }
 
 /**
- * AIReady Unified Analysis
+ * AIReady Unified Analysis.
  * Orchestrates all registered tools via the ToolRegistry.
+ *
+ * @param options - Unified analysis configuration including tools and rootDir.
+ * @returns Promise resolving to the consolidated analysis result.
+ * @lastUpdated 2026-03-18
  */
 export async function analyzeUnified(
   options: UnifiedAnalysisOptions
@@ -347,8 +351,12 @@ export async function analyzeUnified(
 }
 
 /**
- * AIReady Unified Scoring
+ * AIReady Unified Scoring.
  * Calculates scores for all analyzed tools.
+ *
+ * @param results - The consolidated results from a unified analysis.
+ * @param options - Analysis options for weighting and budget calculation.
+ * @returns Promise resolving to the final scoring result.
  */
 export async function scoreUnified(
   results: UnifiedAnalysisResult,
@@ -419,7 +427,10 @@ export async function scoreUnified(
 }
 
 /**
- * Generate human-readable summary of unified results
+ * Generate human-readable summary of unified results.
+ *
+ * @param result - The consolidated analysis result object.
+ * @returns Formatted summary string.
  */
 export function generateUnifiedSummary(result: UnifiedAnalysisResult): string {
   const { summary } = result;

package/src/utils/helpers.ts

@@ -22,7 +22,10 @@ export function getReportTimestamp(): string {
 }
 
 /**
- * Warn if graph caps may be exceeded
+ * Warn if graph caps may be exceeded for visualization.
+ *
+ * @param report - The combined analysis report.
+ * @param dirPath - Root directory to look for configuration.
  */
 export async function warnIfGraphCapExceeded(report: any, dirPath: string) {
   try {
@@ -90,7 +93,11 @@ export async function warnIfGraphCapExceeded(report: any, dirPath: string) {
 }
 
 /**
- * Generate markdown report for consistency command
+ * Generate markdown report for consistency command.
+ *
+ * @param report - The consistency report object.
+ * @param elapsedTime - Time taken for analysis in seconds.
+ * @returns Formatted markdown string.
  */
 export function generateMarkdownReport(
   report: any,
@@ -117,7 +124,11 @@ export function generateMarkdownReport(
 }
 
 /**
- * Truncate array for display (show first N items with "... +N more")
+ * Truncate array for display (show first N items with "... +N more").
+ *
+ * @param arr - The array to truncate.
+ * @param cap - Maximum number of items to show before truncating.
+ * @returns Formatted string for display.
  */
 export function truncateArray(arr: any[] | undefined, cap = 8): string {
   if (!Array.isArray(arr)) return '';
@@ -128,6 +139,10 @@ export function truncateArray(arr: any[] | undefined, cap = 8): string {
 
 /**
  * Build a common ToolScoringOutput payload from a tool report.
+ *
+ * @param toolName - Identifier for the tool.
+ * @param report - Minimal report structure containing score and recommendations.
+ * @returns Standardized scoring output.
  */
 export function buildToolScoringOutput(
   toolName: string,
@@ -152,6 +167,10 @@ export function buildToolScoringOutput(
 
 /**
  * Load config and apply tool-level defaults.
+ *
+ * @param directory - Directory to search for config.
+ * @param defaults - Tool-specific default values.
+ * @returns Merged configuration with tool defaults.
  */
 export async function loadMergedToolConfig<T extends Record<string, unknown>>(
   directory: string,
@@ -164,6 +183,11 @@ export async function loadMergedToolConfig<T extends Record<string, unknown>>(
 
 /**
  * Shared base scan options used by CLI tool commands.
+ *
+ * @param directory - Root directory for scanning.
+ * @param options - CLI commander options object.
+ * @param extras - Additional tool-specific options.
+ * @returns Combined scan options for the analyzer.
  */
 export function buildCommonScanOptions(
   directory: string,
@@ -180,6 +204,9 @@ export function buildCommonScanOptions(
 
 /**
  * Execute a config-driven tool command with shared CLI plumbing.
+ *
+ * @param params - Execution parameters including analyze and score callbacks.
+ * @returns Promise resolving to the tool report and its scoring output.
  */
 export async function runConfiguredToolCommand<TReport, TScoring>(params: {
   directory: string;