@malikasadjaved/readme-ai 1.0.0

package/dist/config.js

@@ -0,0 +1,28 @@
+import Conf from 'conf';
+export const config = new Conf({
+    projectName: 'readme-ai',
+    defaults: {
+        provider: 'anthropic',
+        default_theme: 'default',
+        default_output: 'README.md',
+    },
+});
+export function getAPIKey(provider) {
+    switch (provider) {
+        case 'anthropic':
+            return process.env.ANTHROPIC_API_KEY || config.get('anthropic_api_key');
+        case 'openai':
+            return process.env.OPENAI_API_KEY || config.get('openai_api_key');
+        case 'gemini':
+            return process.env.GEMINI_API_KEY || config.get('gemini_api_key');
+        default:
+            return undefined;
+    }
+}
+export function getGitHubToken() {
+    return process.env.GITHUB_TOKEN || config.get('github_token');
+}
+export function getOllamaURL() {
+    return process.env.OLLAMA_BASE_URL || config.get('ollama_url') || 'http://localhost:11434';
+}
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AAcxB,MAAM,CAAC,MAAM,MAAM,GAAG,IAAI,IAAI,CAAiB;IAC7C,WAAW,EAAE,WAAW;IACxB,QAAQ,EAAE;QACR,QAAQ,EAAE,WAAW;QACrB,aAAa,EAAE,SAAS;QACxB,cAAc,EAAE,WAAW;KAC5B;CACF,CAAC,CAAC;AAEH,MAAM,UAAU,SAAS,CAAC,QAAgB;IACxC,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,WAAW;YACd,OAAO,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;QAC1E,KAAK,QAAQ;YACX,OAAO,OAAO,CAAC,GAAG,CAAC,cAAc,IAAI,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QACpE,KAAK,QAAQ;YACX,OAAO,OAAO,CAAC,GAAG,CAAC,cAAc,IAAI,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QACpE;YACE,OAAO,SAAS,CAAC;IACrB,CAAC;AACH,CAAC;AAED,MAAM,UAAU,cAAc;IAC5B,OAAO,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;AAChE,CAAC;AAED,MAAM,UAAU,YAAY;IAC1B,OAAO,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,wBAAwB,CAAC;AAC7F,CAAC"}

package/dist/generators/changelog.d.ts

@@ -0,0 +1,7 @@
+export interface ChangelogEntry {
+    version: string;
+    date: string;
+    changes: string[];
+}
+export declare function generateChangelogSection(entries: ChangelogEntry[]): string;
+//# sourceMappingURL=changelog.d.ts.map

package/dist/generators/changelog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"changelog.d.ts","sourceRoot":"","sources":["../../src/generators/changelog.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,cAAc,EAAE,GAAG,MAAM,CAe1E"}

package/dist/generators/changelog.js

@@ -0,0 +1,15 @@
+export function generateChangelogSection(entries) {
+    if (entries.length === 0)
+        return '';
+    const lines = ['## Changelog', ''];
+    for (const entry of entries) {
+        lines.push(`### ${entry.version} (${entry.date})`);
+        lines.push('');
+        for (const change of entry.changes) {
+            lines.push(`- ${change}`);
+        }
+        lines.push('');
+    }
+    return lines.join('\n');
+}
+//# sourceMappingURL=changelog.js.map

package/dist/generators/changelog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"changelog.js","sourceRoot":"","sources":["../../src/generators/changelog.ts"],"names":[],"mappings":"AAMA,MAAM,UAAU,wBAAwB,CAAC,OAAyB;IAChE,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IAEpC,MAAM,KAAK,GAAa,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IAE7C,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC,OAAO,KAAK,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC;QACnD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YACnC,KAAK,CAAC,IAAI,CAAC,KAAK,MAAM,EAAE,CAAC,CAAC;QAC5B,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC"}

package/dist/generators/contributing.d.ts

@@ -0,0 +1,5 @@
+import type { ScanResult } from '../analyzers/file-scanner.js';
+import type { DependencyAnalysis } from '../analyzers/dependency-analyzer.js';
+export declare function generateContributing(scan: ScanResult, deps?: DependencyAnalysis): string;
+export declare function getLicense(scan: ScanResult): string;
+//# sourceMappingURL=contributing.d.ts.map

package/dist/generators/contributing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contributing.d.ts","sourceRoot":"","sources":["../../src/generators/contributing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAE9E,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,EAAE,kBAAkB,GAAG,MAAM,CAsBxF;AAED,wBAAgB,UAAU,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,CAKnD"}

package/dist/generators/contributing.js

@@ -0,0 +1,28 @@
+export function generateContributing(scan, deps) {
+    const lines = [];
+    lines.push('Contributions are welcome! Here\'s how to get started:');
+    lines.push('');
+    lines.push('1. Fork the repository');
+    lines.push('2. Create a feature branch (`git checkout -b feature/amazing-feature`)');
+    lines.push('3. Make your changes');
+    if (scan.hasTests) {
+        const testCmd = deps?.testCommand || 'npm test';
+        lines.push(`4. Run the tests (\`${testCmd}\`)`);
+        lines.push('5. Commit your changes (`git commit -m \'Add amazing feature\'`)');
+        lines.push('6. Push to the branch (`git push origin feature/amazing-feature`)');
+        lines.push('7. Open a Pull Request');
+    }
+    else {
+        lines.push('4. Commit your changes (`git commit -m \'Add amazing feature\'`)');
+        lines.push('5. Push to the branch (`git push origin feature/amazing-feature`)');
+        lines.push('6. Open a Pull Request');
+    }
+    return lines.join('\n');
+}
+export function getLicense(scan) {
+    if (scan.hasLicense) {
+        return `This project is licensed under the ${scan.hasLicense} License — see the [LICENSE](LICENSE) file for details.`;
+    }
+    return 'See the [LICENSE](LICENSE) file for details.';
+}
+//# sourceMappingURL=contributing.js.map

package/dist/generators/contributing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contributing.js","sourceRoot":"","sources":["../../src/generators/contributing.ts"],"names":[],"mappings":"AAGA,MAAM,UAAU,oBAAoB,CAAC,IAAgB,EAAE,IAAyB;IAC9E,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,CAAC,IAAI,CAAC,wDAAwD,CAAC,CAAC;IACrE,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;IACrC,KAAK,CAAC,IAAI,CAAC,wEAAwE,CAAC,CAAC;IACrF,KAAK,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;IAEnC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClB,MAAM,OAAO,GAAG,IAAI,EAAE,WAAW,IAAI,UAAU,CAAC;QAChD,KAAK,CAAC,IAAI,CAAC,uBAAuB,OAAO,KAAK,CAAC,CAAC;QAChD,KAAK,CAAC,IAAI,CAAC,kEAAkE,CAAC,CAAC;QAC/E,KAAK,CAAC,IAAI,CAAC,mEAAmE,CAAC,CAAC;QAChF,KAAK,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;IACvC,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,IAAI,CAAC,kEAAkE,CAAC,CAAC;QAC/E,KAAK,CAAC,IAAI,CAAC,mEAAmE,CAAC,CAAC;QAChF,KAAK,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;IACvC,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,IAAgB;IACzC,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;QACpB,OAAO,sCAAsC,IAAI,CAAC,UAAU,yDAAyD,CAAC;IACxH,CAAC;IACD,OAAO,8CAA8C,CAAC;AACxD,CAAC"}

package/dist/generators/index.d.ts

@@ -0,0 +1,6 @@
+export { generateOverview, type OverviewResult } from './overview.js';
+export { generateInstallSection, type InstallResult, type InstallStep } from './install.js';
+export { generateUsageSection, generateAPIDocs, type UsageResult, type UsageExample, type APIDocsResult, type APIDocEntry } from './usage.js';
+export { generateContributing, getLicense } from './contributing.js';
+export { generateChangelogSection, type ChangelogEntry } from './changelog.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/generators/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/generators/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,KAAK,cAAc,EAAE,MAAM,eAAe,CAAC;AACtE,OAAO,EAAE,sBAAsB,EAAE,KAAK,aAAa,EAAE,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAC5F,OAAO,EAAE,oBAAoB,EAAE,eAAe,EAAE,KAAK,WAAW,EAAE,KAAK,YAAY,EAAE,KAAK,aAAa,EAAE,KAAK,WAAW,EAAE,MAAM,YAAY,CAAC;AAC9I,OAAO,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,EAAE,wBAAwB,EAAE,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/generators/index.js

@@ -0,0 +1,6 @@
+export { generateOverview } from './overview.js';
+export { generateInstallSection } from './install.js';
+export { generateUsageSection, generateAPIDocs } from './usage.js';
+export { generateContributing, getLicense } from './contributing.js';
+export { generateChangelogSection } from './changelog.js';
+//# sourceMappingURL=index.js.map

package/dist/generators/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/generators/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAuB,MAAM,eAAe,CAAC;AACtE,OAAO,EAAE,sBAAsB,EAAwC,MAAM,cAAc,CAAC;AAC5F,OAAO,EAAE,oBAAoB,EAAE,eAAe,EAA6E,MAAM,YAAY,CAAC;AAC9I,OAAO,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,EAAE,wBAAwB,EAAuB,MAAM,gBAAgB,CAAC"}

package/dist/generators/install.d.ts

@@ -0,0 +1,14 @@
+import type { DependencyAnalysis } from '../analyzers/dependency-analyzer.js';
+import type { ScanResult } from '../analyzers/file-scanner.js';
+export interface InstallStep {
+    title: string;
+    command: string;
+}
+export interface InstallResult {
+    prerequisites: string[];
+    installSteps: InstallStep[];
+    envSetupSteps?: InstallStep[];
+    verifyCommand?: string;
+}
+export declare function generateInstallSection(deps: DependencyAnalysis, scan: ScanResult): InstallResult;
+//# sourceMappingURL=install.d.ts.map

package/dist/generators/install.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"install.d.ts","sourceRoot":"","sources":["../../src/generators/install.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE/D,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B,aAAa,CAAC,EAAE,WAAW,EAAE,CAAC;IAC9B,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,UAAU,GAAG,aAAa,CAsGhG"}

package/dist/generators/install.js

@@ -0,0 +1,95 @@
+export function generateInstallSection(deps, scan) {
+    const prerequisites = [];
+    const installSteps = [];
+    const envSetupSteps = [];
+    let verifyCommand;
+    // Clone step
+    installSteps.push({
+        title: 'Clone the repository',
+        command: 'git clone <repository-url>\ncd <project-name>',
+    });
+    switch (deps.packageManager) {
+        case 'npm':
+        case 'yarn':
+        case 'pnpm':
+            prerequisites.push(`Node.js ${deps.nodeVersion || '>= 18'}`);
+            if (deps.packageManager !== 'npm') {
+                prerequisites.push(deps.packageManager);
+            }
+            installSteps.push({
+                title: 'Install dependencies',
+                command: deps.installCommand,
+            });
+            if (deps.buildCommand) {
+                installSteps.push({
+                    title: 'Build the project',
+                    command: deps.buildCommand,
+                });
+            }
+            verifyCommand = deps.runCommand;
+            break;
+        case 'pip':
+            prerequisites.push(`Python ${deps.pythonVersion || '>= 3.9'}`);
+            prerequisites.push('pip');
+            installSteps.push({
+                title: 'Create a virtual environment',
+                command: 'python -m venv venv\nsource venv/bin/activate  # On Windows: venv\\Scripts\\activate',
+            });
+            installSteps.push({
+                title: 'Install dependencies',
+                command: deps.installCommand,
+            });
+            verifyCommand = deps.runCommand;
+            break;
+        case 'cargo':
+            prerequisites.push('Rust (latest stable)');
+            installSteps.push({
+                title: 'Build the project',
+                command: deps.installCommand,
+            });
+            verifyCommand = deps.runCommand;
+            break;
+        case 'go':
+            prerequisites.push('Go >= 1.21');
+            installSteps.push({
+                title: 'Download dependencies',
+                command: deps.installCommand,
+            });
+            if (deps.buildCommand) {
+                installSteps.push({
+                    title: 'Build the project',
+                    command: deps.buildCommand,
+                });
+            }
+            verifyCommand = deps.runCommand;
+            break;
+        default:
+            // No recognized package manager
+            break;
+    }
+    // Environment setup
+    if (deps.requiresEnvFile) {
+        envSetupSteps.push({
+            title: 'Copy the example environment file',
+            command: 'cp .env.example .env',
+        });
+        envSetupSteps.push({
+            title: 'Edit .env with your configuration',
+            command: '# Edit .env and fill in the required values',
+        });
+    }
+    // Docker instructions
+    if (scan.hasDocker) {
+        installSteps.push({
+            title: 'Or run with Docker',
+            command: 'docker compose up --build',
+        });
+    }
+    return {
+        prerequisites,
+        installSteps,
+        envSetupSteps: envSetupSteps.length > 0 ? envSetupSteps : undefined,
+        verifyCommand,
+    };
+}
+//# sourceMappingURL=install.js.map

package/dist/generators/install.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"install.js","sourceRoot":"","sources":["../../src/generators/install.ts"],"names":[],"mappings":"AAeA,MAAM,UAAU,sBAAsB,CAAC,IAAwB,EAAE,IAAgB;IAC/E,MAAM,aAAa,GAAa,EAAE,CAAC;IACnC,MAAM,YAAY,GAAkB,EAAE,CAAC;IACvC,MAAM,aAAa,GAAkB,EAAE,CAAC;IACxC,IAAI,aAAiC,CAAC;IAEtC,aAAa;IACb,YAAY,CAAC,IAAI,CAAC;QAChB,KAAK,EAAE,sBAAsB;QAC7B,OAAO,EAAE,+CAA+C;KACzD,CAAC,CAAC;IAEH,QAAQ,IAAI,CAAC,cAAc,EAAE,CAAC;QAC5B,KAAK,KAAK,CAAC;QACX,KAAK,MAAM,CAAC;QACZ,KAAK,MAAM;YACT,aAAa,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,WAAW,IAAI,OAAO,EAAE,CAAC,CAAC;YAC7D,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,EAAE,CAAC;gBAClC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YAC1C,CAAC;YACD,YAAY,CAAC,IAAI,CAAC;gBAChB,KAAK,EAAE,sBAAsB;gBAC7B,OAAO,EAAE,IAAI,CAAC,cAAc;aAC7B,CAAC,CAAC;YACH,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;gBACtB,YAAY,CAAC,IAAI,CAAC;oBAChB,KAAK,EAAE,mBAAmB;oBAC1B,OAAO,EAAE,IAAI,CAAC,YAAY;iBAC3B,CAAC,CAAC;YACL,CAAC;YACD,aAAa,GAAG,IAAI,CAAC,UAAU,CAAC;YAChC,MAAM;QAER,KAAK,KAAK;YACR,aAAa,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,aAAa,IAAI,QAAQ,EAAE,CAAC,CAAC;YAC/D,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC1B,YAAY,CAAC,IAAI,CAAC;gBAChB,KAAK,EAAE,8BAA8B;gBACrC,OAAO,EAAE,sFAAsF;aAChG,CAAC,CAAC;YACH,YAAY,CAAC,IAAI,CAAC;gBAChB,KAAK,EAAE,sBAAsB;gBAC7B,OAAO,EAAE,IAAI,CAAC,cAAc;aAC7B,CAAC,CAAC;YACH,aAAa,GAAG,IAAI,CAAC,UAAU,CAAC;YAChC,MAAM;QAER,KAAK,OAAO;YACV,aAAa,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;YAC3C,YAAY,CAAC,IAAI,CAAC;gBAChB,KAAK,EAAE,mBAAmB;gBAC1B,OAAO,EAAE,IAAI,CAAC,cAAc;aAC7B,CAAC,CAAC;YACH,aAAa,GAAG,IAAI,CAAC,UAAU,CAAC;YAChC,MAAM;QAER,KAAK,IAAI;YACP,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACjC,YAAY,CAAC,IAAI,CAAC;gBAChB,KAAK,EAAE,uBAAuB;gBAC9B,OAAO,EAAE,IAAI,CAAC,cAAc;aAC7B,CAAC,CAAC;YACH,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;gBACtB,YAAY,CAAC,IAAI,CAAC;oBAChB,KAAK,EAAE,mBAAmB;oBAC1B,OAAO,EAAE,IAAI,CAAC,YAAY;iBAC3B,CAAC,CAAC;YACL,CAAC;YACD,aAAa,GAAG,IAAI,CAAC,UAAU,CAAC;YAChC,MAAM;QAER;YACE,gCAAgC;YAChC,MAAM;IACV,CAAC;IAED,oBAAoB;IACpB,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;QACzB,aAAa,CAAC,IAAI,CAAC;YACjB,KAAK,EAAE,mCAAmC;YAC1C,OAAO,EAAE,sBAAsB;SAChC,CAAC,CAAC;QACH,aAAa,CAAC,IAAI,CAAC;YACjB,KAAK,EAAE,mCAAmC;YAC1C,OAAO,EAAE,6CAA6C;SACvD,CAAC,CAAC;IACL,CAAC;IAED,sBAAsB;IACtB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;QACnB,YAAY,CAAC,IAAI,CAAC;YAChB,KAAK,EAAE,oBAAoB;YAC3B,OAAO,EAAE,2BAA2B;SACrC,CAAC,CAAC;IACL,CAAC;IAED,OAAO;QACL,aAAa;QACb,YAAY;QACZ,aAAa,EAAE,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS;QACnE,aAAa;KACd,CAAC;AACJ,CAAC"}

package/dist/generators/overview.d.ts

@@ -0,0 +1,20 @@
+import type { ScanResult } from '../analyzers/file-scanner.js';
+import type { DependencyAnalysis } from '../analyzers/dependency-analyzer.js';
+import type { CodeAnalysis } from '../analyzers/code-analyzer.js';
+import type { AIProvider } from '../providers/index.js';
+export interface OverviewResult {
+    tagline: string;
+    description: string;
+    keyFeatures: string[];
+    useCases: string[];
+    targetAudience: string;
+}
+export declare function generateOverview(params: {
+    scan: ScanResult;
+    deps: DependencyAnalysis;
+    codeAnalysis: CodeAnalysis;
+    provider: AIProvider;
+    existingDescription?: string;
+    userContext?: string;
+}): Promise<OverviewResult>;
+//# sourceMappingURL=overview.d.ts.map

package/dist/generators/overview.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"overview.d.ts","sourceRoot":"","sources":["../../src/generators/overview.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAExD,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,wBAAsB,gBAAgB,CAAC,MAAM,EAAE;IAC7C,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,kBAAkB,CAAC;IACzB,YAAY,EAAE,YAAY,CAAC;IAC3B,QAAQ,EAAE,UAAU,CAAC;IACrB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,GAAG,OAAO,CAAC,cAAc,CAAC,CAiD1B"}

package/dist/generators/overview.js

@@ -0,0 +1,87 @@
+export async function generateOverview(params) {
+    const { scan, deps, codeAnalysis, provider, existingDescription, userContext } = params;
+    const prompt = `Analyze this codebase and generate a README overview.
+
+PROJECT INFO:
+- Primary language: ${scan.languages[0]?.name || 'Unknown'} (${scan.languages[0]?.percentage || 0}%)
+- Other languages: ${scan.languages.slice(1, 4).map(l => l.name).join(', ') || 'None'}
+- Frameworks: ${scan.frameworks.join(', ') || 'None detected'}
+- Package manager: ${deps.packageManager || 'None detected'}
+- Has tests: ${scan.hasTests}
+- Has Docker: ${scan.hasDocker}
+- Has CI/CD: ${scan.hasCICD}
+- License: ${scan.hasLicense || 'Unknown'}
+- Total files: ${scan.totalFiles}
+
+DEPENDENCIES:
+${deps.mainDependencies.slice(0, 15).join(', ') || 'None'}
+
+CODE STRUCTURE:
+${scan.directoryTree}
+
+ENTRY POINTS:
+${scan.entryPoints.join(', ') || 'None found'}
+
+KEY CODE PATTERNS DETECTED:
+- API Endpoints: ${codeAnalysis.apiEndpoints.map(e => `${e.method} ${e.path}`).join(', ') || 'None'}
+- CLI Commands: ${codeAnalysis.cliCommands.map(c => c.name).join(', ') || 'None'}
+- Main exports: ${codeAnalysis.exports.slice(0, 10).map(e => e.name).join(', ') || 'None'}
+- Environment variables: ${codeAnalysis.envVariables.join(', ') || 'None'}
+
+${existingDescription ? `EXISTING DESCRIPTION: ${existingDescription}` : ''}
+${userContext ? `USER-PROVIDED CONTEXT: ${userContext}` : ''}
+
+Generate a JSON response with these fields:
+{
+  "tagline": "A compelling one-line description (under 100 chars)",
+  "description": "2-3 paragraph project description that explains what the project does, why it exists, and its key technical approach",
+  "keyFeatures": ["5-7 bullet points highlighting key features, each starting with an emoji"],
+  "useCases": ["3 use case examples showing who would use this and how"],
+  "targetAudience": "One sentence describing the target user"
+}`;
+    try {
+        return await provider.generateJSON(prompt);
+    }
+    catch {
+        // Fallback: generate from available data
+        return buildFallbackOverview(scan, deps, codeAnalysis, existingDescription);
+    }
+}
+function buildFallbackOverview(scan, deps, code, existingDescription) {
+    const lang = scan.languages[0]?.name || 'Unknown';
+    const frameworks = scan.frameworks;
+    const tagline = existingDescription || `A ${lang} project${frameworks.length ? ` built with ${frameworks[0]}` : ''}`;
+    const parts = [];
+    parts.push(`This project is built with ${lang}${frameworks.length ? ` using ${frameworks.join(', ')}` : ''}.`);
+    if (code.apiEndpoints.length > 0) {
+        parts.push(`It exposes ${code.apiEndpoints.length} API endpoint${code.apiEndpoints.length > 1 ? 's' : ''}.`);
+    }
+    if (code.cliCommands.length > 0) {
+        parts.push(`It provides ${code.cliCommands.length} CLI command${code.cliCommands.length > 1 ? 's' : ''}.`);
+    }
+    if (scan.hasTests)
+        parts.push('The project includes a test suite.');
+    if (scan.hasDocker)
+        parts.push('Docker support is included for containerized deployment.');
+    const features = [];
+    if (frameworks.length)
+        features.push(`Built with ${frameworks.join(', ')}`);
+    if (scan.hasTests)
+        features.push('Includes test suite');
+    if (scan.hasDocker)
+        features.push('Docker support');
+    if (scan.hasCICD)
+        features.push('CI/CD pipeline configured');
+    if (code.apiEndpoints.length > 0)
+        features.push(`${code.apiEndpoints.length} API endpoints`);
+    if (deps.requiresDatabase)
+        features.push('Database integration');
+    return {
+        tagline,
+        description: parts.join(' '),
+        keyFeatures: features.length > 0 ? features : [`Built with ${lang}`],
+        useCases: [`Use as a ${lang} ${frameworks[0] || 'application'}`],
+        targetAudience: `Developers working with ${lang}`,
+    };
+}
+//# sourceMappingURL=overview.js.map

package/dist/generators/overview.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"overview.js","sourceRoot":"","sources":["../../src/generators/overview.ts"],"names":[],"mappings":"AAaA,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,MAOtC;IACC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,mBAAmB,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;IAExF,MAAM,MAAM,GAAG;;;sBAGK,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,UAAU,IAAI,CAAC;qBAC5E,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM;gBACrE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,eAAe;qBACxC,IAAI,CAAC,cAAc,IAAI,eAAe;eAC5C,IAAI,CAAC,QAAQ;gBACZ,IAAI,CAAC,SAAS;eACf,IAAI,CAAC,OAAO;aACd,IAAI,CAAC,UAAU,IAAI,SAAS;iBACxB,IAAI,CAAC,UAAU;;;EAG9B,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM;;;EAGvD,IAAI,CAAC,aAAa;;;EAGlB,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,YAAY;;;mBAG1B,YAAY,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM;kBACjF,YAAY,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM;kBAC9D,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM;2BAC9D,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM;;EAEvE,mBAAmB,CAAC,CAAC,CAAC,yBAAyB,mBAAmB,EAAE,CAAC,CAAC,CAAC,EAAE;EACzE,WAAW,CAAC,CAAC,CAAC,0BAA0B,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE;;;;;;;;;EAS1D,CAAC;IAED,IAAI,CAAC;QACH,OAAO,MAAM,QAAQ,CAAC,YAAY,CAAiB,MAAM,CAAC,CAAC;IAC7D,CAAC;IAAC,MAAM,CAAC;QACP,yCAAyC;QACzC,OAAO,qBAAqB,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,mBAAmB,CAAC,CAAC;IAC9E,CAAC;AACH,CAAC;AAED,SAAS,qBAAqB,CAC5B,IAAgB,EAChB,IAAwB,EACxB,IAAkB,EAClB,mBAA4B;IAE5B,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,SAAS,CAAC;IAClD,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;IAEnC,MAAM,OAAO,GAAG,mBAAmB,IAAI,KAAK,IAAI,WAAW,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,eAAe,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAErH,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,CAAC,IAAI,CAAC,8BAA8B,IAAI,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAC/G,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACjC,KAAK,CAAC,IAAI,CAAC,cAAc,IAAI,CAAC,YAAY,CAAC,MAAM,gBAAgB,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAC/G,CAAC;IACD,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChC,KAAK,CAAC,IAAI,CAAC,eAAe,IAAI,CAAC,WAAW,CAAC,MAAM,eAAe,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAC7G,CAAC;IACD,IAAI,IAAI,CAAC,QAAQ;QAAE,KAAK,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC;IACpE,IAAI,IAAI,CAAC,SAAS;QAAE,KAAK,CAAC,IAAI,CAAC,0DAA0D,CAAC,CAAC;IAE3F,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,IAAI,UAAU,CAAC,MAAM;QAAE,QAAQ,CAAC,IAAI,CAAC,cAAc,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC5E,IAAI,IAAI,CAAC,QAAQ;QAAE,QAAQ,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;IACxD,IAAI,IAAI,CAAC,SAAS;QAAE,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACpD,IAAI,IAAI,CAAC,OAAO;QAAE,QAAQ,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;IAC7D,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC;QAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,gBAAgB,CAAC,CAAC;IAC7F,IAAI,IAAI,CAAC,gBAAgB;QAAE,QAAQ,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;IAEjE,OAAO;QACL,OAAO;QACP,WAAW,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;QAC5B,WAAW,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,cAAc,IAAI,EAAE,CAAC;QACpE,QAAQ,EAAE,CAAC,YAAY,IAAI,IAAI,UAAU,CAAC,CAAC,CAAC,IAAI,aAAa,EAAE,CAAC;QAChE,cAAc,EAAE,2BAA2B,IAAI,EAAE;KAClD,CAAC;AACJ,CAAC"}

package/dist/generators/usage.d.ts

@@ -0,0 +1,33 @@
+import type { CodeAnalysis } from '../analyzers/code-analyzer.js';
+import type { ScanResult } from '../analyzers/file-scanner.js';
+import type { DependencyAnalysis } from '../analyzers/dependency-analyzer.js';
+import type { AIProvider } from '../providers/index.js';
+export interface UsageExample {
+    title: string;
+    description: string;
+    language: string;
+    code: string;
+}
+export interface UsageResult {
+    examples: UsageExample[];
+}
+export interface APIDocEntry {
+    name: string;
+    signature: string;
+    description: string;
+    file: string;
+}
+export interface APIDocsResult {
+    entries: APIDocEntry[];
+}
+export declare function generateUsageSection(params: {
+    codeAnalysis: CodeAnalysis;
+    scan: ScanResult;
+    deps: DependencyAnalysis;
+    provider: AIProvider;
+}): Promise<UsageResult>;
+export declare function generateAPIDocs(params: {
+    codeAnalysis: CodeAnalysis;
+    provider: AIProvider;
+}): Promise<APIDocsResult>;
+//# sourceMappingURL=usage.d.ts.map

package/dist/generators/usage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"usage.d.ts","sourceRoot":"","sources":["../../src/generators/usage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAExD,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,YAAY,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,WAAW,EAAE,CAAC;CACxB;AAED,wBAAsB,oBAAoB,CAAC,MAAM,EAAE;IACjD,YAAY,EAAE,YAAY,CAAC;IAC3B,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,kBAAkB,CAAC;IACzB,QAAQ,EAAE,UAAU,CAAC;CACtB,GAAG,OAAO,CAAC,WAAW,CAAC,CA6EvB;AA+BD,wBAAsB,eAAe,CAAC,MAAM,EAAE;IAC5C,YAAY,EAAE,YAAY,CAAC;IAC3B,QAAQ,EAAE,UAAU,CAAC;CACtB,GAAG,OAAO,CAAC,aAAa,CAAC,CAwCzB"}

package/dist/generators/usage.js

@@ -0,0 +1,130 @@
+export async function generateUsageSection(params) {
+    const { codeAnalysis, scan, deps, provider } = params;
+    // Build usage examples from detected patterns
+    const examples = [];
+    // Run command
+    if (deps.runCommand) {
+        examples.push({
+            title: 'Running the project',
+            description: 'Start the application:',
+            language: 'bash',
+            code: deps.runCommand,
+        });
+    }
+    // Test command
+    if (deps.testCommand) {
+        examples.push({
+            title: 'Running tests',
+            description: 'Execute the test suite:',
+            language: 'bash',
+            code: deps.testCommand,
+        });
+    }
+    // API endpoints
+    if (codeAnalysis.apiEndpoints.length > 0) {
+        const curlExamples = codeAnalysis.apiEndpoints.slice(0, 3).map(ep => {
+            const method = ep.method === 'GET' ? '' : ` -X ${ep.method}`;
+            return `curl${method} http://localhost:3000${ep.path}`;
+        }).join('\n');
+        examples.push({
+            title: 'API Examples',
+            description: 'Making requests to the API:',
+            language: 'bash',
+            code: curlExamples,
+        });
+    }
+    // CLI commands
+    if (codeAnalysis.cliCommands.length > 0) {
+        const cmdExamples = codeAnalysis.cliCommands.slice(0, 3)
+            .map(cmd => `# ${cmd.description}\n${cmd.name}`)
+            .join('\n\n');
+        examples.push({
+            title: 'CLI Commands',
+            description: 'Available commands:',
+            language: 'bash',
+            code: cmdExamples,
+        });
+    }
+    // If we have very few examples, ask AI for more
+    if (examples.length < 2 && codeAnalysis.exports.length > 0) {
+        try {
+            const aiExamples = await generateAIUsageExamples(codeAnalysis, scan, provider);
+            examples.push(...aiExamples);
+        }
+        catch {
+            // AI generation failed, that's ok
+        }
+    }
+    // Ensure at least one example
+    if (examples.length === 0) {
+        const lang = scan.languages[0]?.name || 'Unknown';
+        examples.push({
+            title: 'Getting Started',
+            description: `Start using the project:`,
+            language: 'bash',
+            code: deps.runCommand || deps.installCommand || `# See documentation for usage instructions`,
+        });
+    }
+    return { examples };
+}
+async function generateAIUsageExamples(code, scan, provider) {
+    const exports = code.exports.slice(0, 5).map(e => `${e.type} ${e.signature} (${e.file})`).join('\n');
+    const prompt = `Generate 2 practical usage examples for this project.
+
+Language: ${scan.languages[0]?.name || 'Unknown'}
+Key exports:
+${exports}
+
+Return JSON:
+{
+  "examples": [
+    {
+      "title": "Example title",
+      "description": "What this example demonstrates",
+      "language": "${scan.languages[0]?.name === 'Python' ? 'python' : 'typescript'}",
+      "code": "// actual code example"
+    }
+  ]
+}`;
+    const result = await provider.generateJSON(prompt);
+    return result.examples || [];
+}
+export async function generateAPIDocs(params) {
+    const { codeAnalysis, provider } = params;
+    // Group exports by file
+    const entries = codeAnalysis.exports
+        .filter(exp => exp.type === 'function' || exp.type === 'class')
+        .slice(0, 20)
+        .map(exp => ({
+        name: exp.name,
+        signature: exp.signature,
+        description: '',
+        file: exp.file,
+    }));
+    // Try to get AI descriptions for the exports
+    if (entries.length > 0 && entries.length <= 15) {
+        try {
+            const prompt = `Generate brief descriptions (1 sentence each) for these exported functions/classes:
+
+${entries.map(e => `- ${e.signature} (in ${e.file})`).join('\n')}
+
+Return JSON:
+{
+  "descriptions": {
+    "functionName": "Brief description of what it does"
+  }
+}`;
+            const result = await provider.generateJSON(prompt);
+            for (const entry of entries) {
+                if (result.descriptions[entry.name]) {
+                    entry.description = result.descriptions[entry.name];
+                }
+            }
+        }
+        catch {
+            // AI failed, leave descriptions empty
+        }
+    }
+    return { entries };
+}
+//# sourceMappingURL=usage.js.map

package/dist/generators/usage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usage.js","sourceRoot":"","sources":["../../src/generators/usage.ts"],"names":[],"mappings":"AA2BA,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,MAK1C;IACC,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;IAEtD,8CAA8C;IAC9C,MAAM,QAAQ,GAAmB,EAAE,CAAC;IAEpC,cAAc;IACd,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;QACpB,QAAQ,CAAC,IAAI,CAAC;YACZ,KAAK,EAAE,qBAAqB;YAC5B,WAAW,EAAE,wBAAwB;YACrC,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE,IAAI,CAAC,UAAU;SACtB,CAAC,CAAC;IACL,CAAC;IAED,eAAe;IACf,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;QACrB,QAAQ,CAAC,IAAI,CAAC;YACZ,KAAK,EAAE,eAAe;YACtB,WAAW,EAAE,yBAAyB;YACtC,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE,IAAI,CAAC,WAAW;SACvB,CAAC,CAAC;IACL,CAAC;IAED,gBAAgB;IAChB,IAAI,YAAY,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACzC,MAAM,YAAY,GAAG,YAAY,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;YAClE,MAAM,MAAM,GAAG,EAAE,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC;YAC7D,OAAO,OAAO,MAAM,yBAAyB,EAAE,CAAC,IAAI,EAAE,CAAC;QACzD,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEd,QAAQ,CAAC,IAAI,CAAC;YACZ,KAAK,EAAE,cAAc;YACrB,WAAW,EAAE,6BAA6B;YAC1C,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE,YAAY;SACnB,CAAC,CAAC;IACL,CAAC;IAED,eAAe;IACf,IAAI,YAAY,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxC,MAAM,WAAW,GAAG,YAAY,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;aACrD,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,GAAG,CAAC,WAAW,KAAK,GAAG,CAAC,IAAI,EAAE,CAAC;aAC/C,IAAI,CAAC,MAAM,CAAC,CAAC;QAEhB,QAAQ,CAAC,IAAI,CAAC;YACZ,KAAK,EAAE,cAAc;YACrB,WAAW,EAAE,qBAAqB;YAClC,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE,WAAW;SAClB,CAAC,CAAC;IACL,CAAC;IAED,gDAAgD;IAChD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,YAAY,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3D,IAAI,CAAC;YACH,MAAM,UAAU,GAAG,MAAM,uBAAuB,CAAC,YAAY,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;YAC/E,QAAQ,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC;QAC/B,CAAC;QAAC,MAAM,CAAC;YACP,kCAAkC;QACpC,CAAC;IACH,CAAC;IAED,8BAA8B;IAC9B,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,SAAS,CAAC;QAClD,QAAQ,CAAC,IAAI,CAAC;YACZ,KAAK,EAAE,iBAAiB;YACxB,WAAW,EAAE,0BAA0B;YACvC,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,cAAc,IAAI,4CAA4C;SAC7F,CAAC,CAAC;IACL,CAAC;IAED,OAAO,EAAE,QAAQ,EAAE,CAAC;AACtB,CAAC;AAED,KAAK,UAAU,uBAAuB,CACpC,IAAkB,EAClB,IAAgB,EAChB,QAAoB;IAEpB,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAErG,MAAM,MAAM,GAAG;;YAEL,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,SAAS;;EAE9C,OAAO;;;;;;;;qBAQY,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY;;;;EAIjF,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,YAAY,CAA+B,MAAM,CAAC,CAAC;IACjF,OAAO,MAAM,CAAC,QAAQ,IAAI,EAAE,CAAC;AAC/B,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,MAGrC;IACC,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;IAE1C,wBAAwB;IACxB,MAAM,OAAO,GAAkB,YAAY,CAAC,OAAO;SAChD,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,UAAU,IAAI,GAAG,CAAC,IAAI,KAAK,OAAO,CAAC;SAC9D,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC;SACZ,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACX,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,SAAS,EAAE,GAAG,CAAC,SAAS;QACxB,WAAW,EAAE,EAAE;QACf,IAAI,EAAE,GAAG,CAAC,IAAI;KACf,CAAC,CAAC,CAAC;IAEN,6CAA6C;IAC7C,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,MAAM,IAAI,EAAE,EAAE,CAAC;QAC/C,IAAI,CAAC;YACH,MAAM,MAAM,GAAG;;EAEnB,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,SAAS,QAAQ,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;;;;;;;EAO9D,CAAC;YAEG,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,YAAY,CAA2C,MAAM,CAAC,CAAC;YAC7F,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;gBAC5B,IAAI,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;oBACpC,KAAK,CAAC,WAAW,GAAG,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACtD,CAAC;YACH,CAAC;QACH,CAAC;QAAC,MAAM,CAAC;YACP,sCAAsC;QACxC,CAAC;IACH,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,CAAC;AACrB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}

package/dist/index.js

@@ -0,0 +1,47 @@
+#!/usr/bin/env node
+import { Command } from 'commander';
+import { runGenerate } from './commands/generate.js';
+import { runCLI } from './cli.js';
+import { createRequire } from 'node:module';
+const require = createRequire(import.meta.url);
+const pkg = require('../package.json');
+const program = new Command();
+program
+    .name('readme-ai')
+    .description('Generate production-quality READMEs from any codebase')
+    .version(pkg.version)
+    .argument('[repo]', 'Local path or GitHub URL (github:user/repo or https://github.com/...)')
+    .option('-o, --output <file>', 'Output file path', 'README.md')
+    .option('-p, --provider <name>', 'AI provider: anthropic | openai | gemini | ollama', 'anthropic')
+    .option('-m, --model <name>', 'Model name (depends on provider)')
+    .option('-t, --theme <name>', 'README theme: default | minimal | hacker | modern | academic', 'default')
+    .option('--no-diagram', 'Skip Mermaid architecture diagram')
+    .option('--no-badges', 'Skip badge generation')
+    .option('--no-api-docs', 'Skip API documentation section')
+    .option('--interactive', 'Run in interactive mode (asks questions about your project)')
+    .option('--action', 'Also generate a GitHub Action for auto-updating README')
+    .option('--overwrite', 'Overwrite existing README without asking')
+    .option('--dry-run', 'Print README to stdout instead of writing to file')
+    .action(async (repo, opts) => {
+    if (!repo && opts.interactive) {
+        await runCLI();
+    }
+    else {
+        await runGenerate({
+            repo: repo || '.',
+            output: opts.output,
+            provider: opts.provider,
+            model: opts.model,
+            theme: opts.theme,
+            diagram: opts.diagram,
+            badges: opts.badges,
+            apiDocs: opts.apiDocs,
+            interactive: opts.interactive,
+            action: opts.action,
+            overwrite: opts.overwrite,
+            dryRun: opts.dryRun,
+        });
+    }
+});
+program.parse();
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC/C,MAAM,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAEvC,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,WAAW,CAAC;KACjB,WAAW,CAAC,uDAAuD,CAAC;KACpE,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;KACpB,QAAQ,CAAC,QAAQ,EAAE,uEAAuE,CAAC;KAC3F,MAAM,CAAC,qBAAqB,EAAE,kBAAkB,EAAE,WAAW,CAAC;KAC9D,MAAM,CAAC,uBAAuB,EAAE,mDAAmD,EAAE,WAAW,CAAC;KACjG,MAAM,CAAC,oBAAoB,EAAE,kCAAkC,CAAC;KAChE,MAAM,CAAC,oBAAoB,EAAE,8DAA8D,EAAE,SAAS,CAAC;KACvG,MAAM,CAAC,cAAc,EAAE,mCAAmC,CAAC;KAC3D,MAAM,CAAC,aAAa,EAAE,uBAAuB,CAAC;KAC9C,MAAM,CAAC,eAAe,EAAE,gCAAgC,CAAC;KACzD,MAAM,CAAC,eAAe,EAAE,6DAA6D,CAAC;KACtF,MAAM,CAAC,UAAU,EAAE,wDAAwD,CAAC;KAC5E,MAAM,CAAC,aAAa,EAAE,0CAA0C,CAAC;KACjE,MAAM,CAAC,WAAW,EAAE,mDAAmD,CAAC;KACxE,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;IAC3B,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;QAC9B,MAAM,MAAM,EAAE,CAAC;IACjB,CAAC;SAAM,CAAC;QACN,MAAM,WAAW,CAAC;YAChB,IAAI,EAAE,IAAI,IAAI,GAAG;YACjB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,OAAO,CAAC,KAAK,EAAE,CAAC"}

package/dist/providers/anthropic.d.ts

@@ -0,0 +1,3 @@
+import type { AIProvider } from './index.js';
+export declare function createAnthropicProvider(model?: string): AIProvider;
+//# sourceMappingURL=anthropic.d.ts.map

package/dist/providers/anthropic.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"anthropic.d.ts","sourceRoot":"","sources":["../../src/providers/anthropic.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAG7C,wBAAgB,uBAAuB,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,UAAU,CAmDlE"}