summarizer-cli/bin/cli.js

CLI tool to summarize functions or whole file using LLM

#!/usr/bin/env node

import chalk from 'chalk';
import { Command } from 'commander';
import dotenv from 'dotenv';
import figlet from 'figlet';
import gradient from 'gradient-string';
import { marked } from 'marked';
import TerminalRenderer from 'marked-terminal';
import ora from 'ora';
import { extractFunctionFromFile } from '../lib/extractor.js';
import { saveSummary } from '../lib/saveSummary.js';
import { summarizeFile, summarizeFunction, summarizePrompt } from '../lib/summarizer.js';
import { applyMarkdownParser } from '../lib/markdownParser.js';
import { customHelpText } from '../lib/helpCommand.js';

marked.setOptions({
    renderer: new TerminalRenderer(),
});

dotenv.config();

const program = new Command();

console.log(gradient.pastel(figlet.textSync('Summarizer CLI 🚀', { horizontalLayout: 'full' })));

program
    .name('summarizer')
    .description('🧠 CLI to summarize code, file or functions using LLM.')
    .version('1.2.0');

program
    .argument('[prompt]', 'Prompt text like "Summarize getUser function in utils.js"')
    .option('-f, --file <path>', 'Summarize an entire code file')
    .option('-n, --function <functionName>', 'Summarize a specific function from file (needs --file)')
    .option('--save', 'Save the generated output to ./summaries directory.')
    .option('--apikey [apikey]', 'Enter the Gemini API key')
    .option('--format <type>', 'Output format: md, txt, or json (used only if --save is passed)')
    .helpOption(false)
    .option('-h, --help', 'display help for command')
    .hook('preAction', (thisCommand) => {
        if (thisCommand.opts().help) {
            console.log(customHelpText());
            process.exit(0);
        }
    })

    .action(async (prompt, options) => {
        const spinner = ora();
        let summary = '';

        try {
            if (!options.apikey) {
                spinner.fail(' Please provide a gemini api key.');
                return
            }
            if (options.function && options.file) {
                spinner.start(`🔍 Extracting function "${options.function}" from ${options.file}...`);
                const fnCode = await extractFunctionFromFile(options.file, options.function);
                spinner.text = 'Summarizing function using LLM...';
                if (prompt) {
                    summary = await summarizeFunction(fnCode, options.apikey, prompt);
                }
                else {
                    summary = await summarizeFunction(fnCode, options.apikey);
                }
                spinner.succeed('Function summary complete!');
                console.log(chalk.cyanBright('\n📌 Summary:\n') + applyMarkdownParser(summary));

            } else if (options.file) {
                spinner.start(`📄 Reading file: ${options.file}`)
                if (prompt) {
                    summary = await summarizeFile(options.file, options.apikey, prompt);
                }
                else {
                    summary = await summarizeFile(options.file, options.apikey);
                };
                spinner.succeed('File summary complete!');
                console.log(chalk.cyanBright('\n📄 Summary:\n') + applyMarkdownParser(summary));

            } else if (prompt) {
                spinner.start('🧠 Generating prompt-based summary...');
                summary = await summarizePrompt(prompt, options.apikey);
                spinner.succeed('Prompt summary complete!');
                console.log(chalk.cyanBright('\n📌 Summary:\n') + applyMarkdownParser(summary));
            } else {
                spinner.fail('❌ Please provide a prompt or file path.');
            }

            if (options.save) {
                saveSummary(summary, options.format || 'md');
            }
        } catch (err) {
            spinner.fail('🚫 Error occurred');
            console.error(chalk.red('Error:'), err.message);
        }
    });


program.parse();

program.outputHelp = () => {
    console.log(createHelpText());
};