@rahul05ranjan/dhruv-cli 1.4.6 → 1.5.0

package/dist/index.js

@@ -19,6 +19,7 @@ import { menu } from './commands/menu.js';
 import { createRequire } from 'module';
 import { logger, logInfo, logError } from './core/logger.js';
 import { metricsCollector } from './core/metrics.js';
+import { commandDescription, completionCommands, completionOptions } from './core/command-catalog.js';
 const require = createRequire(import.meta.url);
 const pkg = require('../package.json');
 const program = new Command();
@@ -28,69 +29,78 @@ program
     .version(pkg.version);
 program
     .command('explain <query>')
-    .description('Explain a concept or command')
+    .description(commandDescription('explain'))
     .addHelpText('after', '\nExamples:\n  $ dhruv explain "What is async/await?"\n  $ dhruv explain "Docker containers vs VMs"')
     .action(explain);
 program
     .command('suggest <query>')
-    .description('Get AI-powered suggestions')
+    .description(commandDescription('suggest'))
     .addHelpText('after', '\nExamples:\n  $ dhruv suggest "React performance optimization"\n  $ dhruv suggest "Node.js project structure"')
     .action(suggest);
 program
     .command('fix <query>')
-    .description('Get a fix for a coding issue or error')
+    .description(commandDescription('fix'))
     .addHelpText('after', '\nExamples:\n  $ dhruv fix "TypeError: Cannot read property of undefined"\n  $ dhruv fix "CORS error in Express.js"')
     .action(fix);
 program
     .command('review <fileOrDir>')
-    .description('Review code in a file or directory')
-    .action(review);
+    .description(commandDescription('review'))
+    .option('--diff', 'Review the current uncommitted git diff')
+    .action((fileOrDir, command) => review(fileOrDir, command.opts()));
 program
     .command('optimize <file>')
-    .description('Optimize a file (e.g., package.json)')
+    .description(commandDescription('optimize'))
     .action(optimize);
 program
     .command('security-check [fileOrDir]')
-    .description('Run a security check on code')
-    .action(securityCheck);
+    .description(commandDescription('security-check'))
+    .option('--strict', 'Exit with failure when high-confidence findings are detected')
+    .action((fileOrDir, command) => securityCheck(fileOrDir, command.opts()));
 program
     .command('generate <type> <target>')
-    .description('Generate code/tests for a file')
-    .action(generate);
+    .description(commandDescription('generate'))
+    .option('--apply', 'Write generated tests to disk (preview is the default)')
+    .option('--output <path>', 'Write generated tests to this path')
+    .option('--overwrite', 'Allow replacing an existing output file')
+    .action((type, target, command) => generate(type, target, command.opts()));
 program
     .command('init')
-    .description('Interactive setup/configuration wizard')
+    .description(commandDescription('init'))
     .action(init);
 program
     .command('status')
-    .description('Check Ollama connection and available models')
+    .description(commandDescription('status'))
     .action(status);
 program
     .command('health')
-    .description('Run comprehensive health check')
-    .action(health);
+    .description(commandDescription('health'))
+    .option('--details', 'Show every health check and diagnostic detail')
+    .action((command) => health(command.opts()));
 program
     .command('metrics')
-    .description('Display CLI usage metrics')
-    .action(metrics);
+    .description(commandDescription('metrics'))
+    .option('--raw', 'Export raw Prometheus metrics')
+    .option('--reset', 'Clear persisted local metrics')
+    .action((command) => metrics(command.opts()));
 program
     .command('project-type')
-    .description('Detect and print the current project type')
+    .description(commandDescription('project-type'))
     .action(() => {
     const type = detectProjectType();
     console.log(chalk.blue(`Detected project type: ${type}`));
 });
 program
     .command('menu')
-    .description('Interactive command palette')
+    .description(commandDescription('menu'))
     .action(menu);
 program
     .option('--model <model>', 'Set Ollama model')
     .option('--verbose', 'Enable verbose output')
     .option('--json', 'Output in JSON format')
+    .option('--timeout <milliseconds>', 'Set the AI request timeout')
     .hook('preAction', async (thisCommand) => {
     const opts = thisCommand.opts();
-    if (opts.model || opts.verbose || opts.json) {
+    if (opts.model || opts.verbose || opts.json || opts.timeout) {
         const config = {};
         if (opts.model)
             config.model = opts.model;
@@ -98,6 +108,8 @@ program
             config.verbose = true;
         if (opts.json)
             config.responseFormat = 'json';
+        if (opts.timeout)
+            config.timeoutMs = Number(opts.timeout);
         // Save config for session
         const configModule = await import('./config/config.js');
         configModule.saveConfig(config);
@@ -148,23 +160,33 @@ async function loadPlugins(program) {
 // Autocomplete: Generate shell completion scripts
 program
     .command('completion')
-    .description('Generate shell completion script')
+    .description(commandDescription('completion'))
     .argument('[shell]', 'shell type (bash|zsh|fish)', 'bash')
     .action((shell) => {
+    const commands = completionCommands();
+    const options = completionOptions();
     let script = '';
     switch (shell) {
         case 'zsh':
-            script = `#compdef dhruv\n_dhruv_completion() {\n  reply=( $(dhruv --help | awk '/Commands:/,/^$/ {if(NR>1)print $1}') )\n}\ncompctl -K _dhruv_completion dhruv`;
+            script = `#compdef dhruv\n_dhruv_completion() {\n  _arguments '1:command:(${commands})' '*:option:(${options})'\n}\ncompdef _dhruv_completion dhruv`;
             break;
         case 'fish':
-            script = `function __fish_dhruv_complete\n  dhruv --help | awk '/Commands:/,/^$/ {if(NR>1)print $1}'\nend\ncomplete -c dhruv -a '(__fish_dhruv_complete)'`;
+            script = `complete -c dhruv -f -n '__fish_use_subcommand' -a '${commands}'\ncomplete -c dhruv -f -n 'not __fish_use_subcommand' -a '${options}'`;
             break;
-        default:
+        case 'bash':
             script = String.raw `#!/bin/bash
 _dhruv_completion() {
-  COMPREPLY=( $(compgen -W "$(dhruv --help | awk '/Commands:/,/^$/ {if(NR>1)print $1}')" -- \${COMP_WORDS[1]}) )
+  local commands="${commands}"
+  local options="${options}"
+  local choices="$commands $options"
+  COMPREPLY=( $(compgen -W "$choices" -- "\${COMP_WORDS[COMP_CWORD]}") )
 }
 complete -F _dhruv_completion dhruv`;
+            break;
+        default:
+            console.error(chalk.red(`Unsupported shell "${shell}". Choose bash, zsh, or fish.`));
+            process.exitCode = 2;
+            return;
     }
     console.log(script);
     console.log(`\n# To enable tab completion, add the above to your shell profile or source it directly.`);

package/dist/utils/projectType.d.ts

@@ -1 +1 @@
-export declare function detectProjectType(): string;
+export declare function detectProjectType(directory?: string): string;

package/dist/utils/projectType.js

@@ -1,17 +1,36 @@
 // Use .js extension for ESM compatibility
 import fs from 'fs';
-export function detectProjectType() {
-    if (fs.existsSync('package.json')) {
-        const pkg = JSON.parse(fs.readFileSync('package.json', 'utf-8'));
-        if (pkg.dependencies?.react || pkg.devDependencies?.react)
+import path from 'path';
+export function detectProjectType(directory = process.cwd()) {
+    const file = (name) => path.join(directory, name);
+    if (fs.existsSync(file('package.json'))) {
+        let pkg;
+        try {
+            pkg = JSON.parse(fs.readFileSync(file('package.json'), 'utf-8'));
+        }
+        catch {
+            return 'unknown';
+        }
+        const dependencies = { ...pkg.dependencies, ...pkg.devDependencies };
+        if (dependencies.react)
             return 'react';
-        if (pkg.dependencies?.express || pkg.devDependencies?.express)
+        if (dependencies.next)
+            return 'nextjs';
+        if (dependencies.express)
             return 'node-express';
+        if (dependencies.typescript || fs.existsSync(file('tsconfig.json')))
+            return 'node-typescript';
         return 'node';
     }
-    if (fs.existsSync('requirements.txt'))
+    if (fs.existsSync(file('requirements.txt')))
         return 'python';
-    if (fs.existsSync('pyproject.toml'))
+    if (fs.existsSync(file('pyproject.toml')))
         return 'python';
+    if (fs.existsSync(file('go.mod')))
+        return 'go';
+    if (fs.existsSync(file('Cargo.toml')))
+        return 'rust';
+    if (fs.existsSync(file('pom.xml')) || fs.existsSync(file('build.gradle')))
+        return 'java';
     return 'unknown';
 }

package/docs/api/assets/highlight.css

@@ -7,10 +7,10 @@
     --dark-hl-2: #9ECBFF;
     --light-hl-3: #005CC5;
     --dark-hl-3: #79B8FF;
-    --light-hl-4: #D73A49;
-    --dark-hl-4: #F97583;
-    --light-hl-5: #6A737D;
-    --dark-hl-5: #6A737D;
+    --light-hl-4: #6A737D;
+    --dark-hl-4: #6A737D;
+    --light-hl-5: #D73A49;
+    --dark-hl-5: #F97583;
     --light-hl-6: #E36209;
     --dark-hl-6: #FFAB70;
     --light-code-background: #fff;

package/docs/api/index.html

@@ -1,39 +1,161 @@
-<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Dhruv CLI API - v1.4.0</title><meta name="description" content="Documentation for Dhruv CLI API"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">Dhruv CLI API - v1.4.0</a><div id="tsd-toolbar-links"><a href="https://rahul05ranjan.github.io/dhruv-cli/">Home</a><a href="https://github.com/rahul05ranjan/dhruv-cli">GitHub</a></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>Dhruv CLI API - v1.4.0</h1></div><div class="tsd-panel tsd-typography"><h1 id="dhruv-cli" class="tsd-anchor-link">Dhruv CLI<a href="#dhruv-cli" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p><a href="https://www.npmjs.com/package/@rahul05ranjan/dhruv-cli">📦 View on npm</a>
-<a href="https://rahul05ranjan.github.io/dhruv-cli/">📖 View Documentation on GitHub Pages</a></p>
-<p>AI-powered CLI assistant for developers using Ollama.</p>
-<h2 id="🚀-features" class="tsd-anchor-link">🚀 Features<a href="#🚀-features" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul>
-<li>Smart command suggestions: <code>suggest</code>, <code>explain</code>, <code>fix</code></li>
-<li>Project context detection (Node, React, Python, etc.)</li>
-<li>Code review: <code>review &lt;fileOrDir&gt;</code></li>
-<li>Code optimization: <code>optimize &lt;file&gt;</code></li>
-<li>Security analysis: <code>security-check [fileOrDir]</code></li>
-<li>Test/code generation: <code>generate &lt;type&gt; &lt;target&gt;</code></li>
-<li>Interactive setup: <code>init</code></li>
-<li>Streaming AI responses in terminal</li>
-<li>Syntax highlighting for code output</li>
-<li>Progress bars for long operations</li>
-<li>Plugin system: drop ESM modules in <code>plugins/</code></li>
-<li>Autocomplete: <code>completion [shell]</code></li>
-<li>Offline-first with local Ollama models</li>
-<li>Beautiful, modern CLI UX</li>
-</ul>
-<h2 id="🛠️-installation" class="tsd-anchor-link">🛠️ Installation<a href="#🛠️-installation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-3">-g</span><span class="hl-1"> </span><span class="hl-2">@rahul05ranjan/dhruv-cli</span>
-</code><button type="button">Copy</button></pre>
-
-<p>Or visit the npm page: <a href="https://www.npmjs.com/package/@rahul05ranjan/dhruv-cli">https://www.npmjs.com/package/@rahul05ranjan/dhruv-cli</a></p>
-<h2 id="📝-usage-examples" class="tsd-anchor-link">📝 Usage Examples<a href="#📝-usage-examples" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="bash"><span class="hl-0">dhruv</span><span class="hl-1"> </span><span class="hl-2">suggest</span><span class="hl-1"> </span><span class="hl-2">&quot;deploy react app to vercel&quot;</span><br/><span class="hl-0">dhruv</span><span class="hl-1"> </span><span class="hl-2">explain</span><span class="hl-1"> </span><span class="hl-2">&quot;git rebase vs merge&quot;</span><br/><span class="hl-0">dhruv</span><span class="hl-1"> </span><span class="hl-2">fix</span><span class="hl-1"> </span><span class="hl-2">&quot;cors error in express&quot;</span><br/><span class="hl-0">dhruv</span><span class="hl-1"> </span><span class="hl-2">review</span><span class="hl-1"> </span><span class="hl-2">src/</span><br/><span class="hl-0">dhruv</span><span class="hl-1"> </span><span class="hl-2">optimize</span><span class="hl-1"> </span><span class="hl-2">package.json</span><br/><span class="hl-0">dhruv</span><span class="hl-1"> </span><span class="hl-2">security-check</span><span class="hl-1"> </span><span class="hl-2">src/</span><br/><span class="hl-0">dhruv</span><span class="hl-1"> </span><span class="hl-2">generate</span><span class="hl-1"> </span><span class="hl-2">tests</span><span class="hl-1"> </span><span class="hl-2">src/utils/helpers.js</span><br/><span class="hl-0">dhruv</span><span class="hl-1"> </span><span class="hl-2">init</span><br/><span class="hl-0">dhruv</span><span class="hl-1"> </span><span class="hl-2">completion</span><span class="hl-1"> </span><span class="hl-2">bash</span><span class="hl-1"> </span><span class="hl-4">&gt;</span><span class="hl-1"> </span><span class="hl-2">dhruv-complete.sh</span><span class="hl-1"> </span><span class="hl-5"># Enable tab completion</span>
-</code><button type="button">Copy</button></pre>
-
-<h2 id="🧩-plugins" class="tsd-anchor-link">🧩 Plugins<a href="#🧩-plugins" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Add new commands by dropping ESM modules in the <code>plugins/</code> directory. Example:</p>
-<pre><code class="js"><span class="hl-5">// plugins/hello.js</span><br/><span class="hl-4">export</span><span class="hl-1"> </span><span class="hl-4">default</span><span class="hl-1"> (</span><span class="hl-6">program</span><span class="hl-1">) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">  program.</span><span class="hl-0">command</span><span class="hl-1">(</span><span class="hl-2">&#39;hello-plugin&#39;</span><span class="hl-1">).</span><span class="hl-0">action</span><span class="hl-1">(() </span><span class="hl-4">=&gt;</span><span class="hl-1"> console.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">&#39;Hello from plugin!&#39;</span><span class="hl-1">));</span><br/><span class="hl-1">};</span>
-</code><button type="button">Copy</button></pre>
-
-<h2 id="📦-configuration" class="tsd-anchor-link">📦 Configuration<a href="#📦-configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul>
-<li>Run <code>dhruv init</code> to set model, response format, and verbosity.</li>
-<li>Project type auto-detected for context-aware suggestions.</li>
-</ul>
-<h2 id="🖥️-advanced-ux" class="tsd-anchor-link">🖥️ Advanced UX<a href="#🖥️-advanced-ux" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul>
-<li>Streaming output, syntax highlighting, progress bars, colored errors, and interactive menus.</li>
-</ul>
-<h2 id="license" class="tsd-anchor-link">License<a href="#license" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>MIT</p>
-</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#dhruv-cli"><span>Dhruv <wbr/>CLI</span></a><ul><li><a href="#🚀-features"><span>🚀 <wbr/>Features</span></a></li><li><a href="#🛠️-installation"><span>🛠️ <wbr/>Installation</span></a></li><li><a href="#📝-usage-examples"><span>📝 <wbr/>Usage <wbr/>Examples</span></a></li><li><a href="#🧩-plugins"><span>🧩 <wbr/>Plugins</span></a></li><li><a href="#📦-configuration"><span>📦 <wbr/>Configuration</span></a></li><li><a href="#🖥️-advanced-ux"><span>🖥️ <wbr/>Advanced <wbr/>UX</span></a></li><li><a href="#license"><span>License</span></a></li></ul></div></details></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://rahul05ranjan.github.io/dhruv-cli/" class="tsd-nav-link">Home</a><a href="https://github.com/rahul05ranjan/dhruv-cli" class="tsd-nav-link">GitHub</a></nav><nav class="tsd-navigation"><a href="modules.html">Dhruv CLI API - v1.4.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
+<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Dhruv CLI API - v1.4.0</title><meta name="description" content="Documentation for Dhruv CLI API"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">Dhruv CLI API - v1.4.0</a><div id="tsd-toolbar-links"><a href="https://rahul05ranjan.github.io/dhruv-cli/">Home</a><a href="https://github.com/rahul05ranjan/dhruv-cli">GitHub</a></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>Dhruv CLI API - v1.4.0</h1></div><div class="tsd-panel tsd-typography"><p align="center">
+  <a href="https://github.com/rahul05ranjan/dhruv-cli">
+    <strong>⚡ Dhruv CLI</strong>
+  </a>
+</p>
+<p align="center">
+  A local-first AI command center for your terminal.
+</p>
+<p align="center">
+  Ask better questions. Understand unfamiliar code. Ship with confidence.
+</p>
+<p align="center">
+  <a href="https://rahul05ranjan.github.io/dhruv-cli/">Website</a>
+  ·
+  <a href="https://www.npmjs.com/package/@rahul05ranjan/dhruv-cli">npm</a>
+  ·
+  <a href="https://github.com/rahul05ranjan/dhruv-cli/issues">Issues</a>
+  ·
+  <a href="media/CONTRIBUTING.md">Contributing</a>
+</p>
+<p align="center">
+  <a href="https://github.com/rahul05ranjan/dhruv-cli/actions/workflows/deploy.yml"><img src="https://github.com/rahul05ranjan/dhruv-cli/actions/workflows/deploy.yml/badge.svg" alt="Deployment status"></a>
+  <a href="https://www.npmjs.com/package/@rahul05ranjan/dhruv-cli"><img src="https://img.shields.io/npm/v/%40rahul05ranjan%2Fdhruv-cli?style=flat-square&label=npm" alt="npm version"></a>
+  <a href="https://www.npmjs.com/package/@rahul05ranjan/dhruv-cli"><img src="https://img.shields.io/npm/dm/%40rahul05ranjan%2Fdhruv-cli?style=flat-square&label=downloads" alt="npm downloads"></a>
+  <img src="https://img.shields.io/github/license/rahul05ranjan/dhruv-cli?style=flat-square" alt="MIT license">
+</p>
+<p align="center">
+  <img src="media/dhruv-cli-preview.svg" alt="Dhruv CLI terminal preview" width="760">
+</p>
+<h2 id="why-dhruv" class="tsd-anchor-link">Why Dhruv?<a href="#why-dhruv" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Dhruv brings a focused AI toolkit into the terminal, powered by local Ollama models. It keeps your workflow close to the codebase, works without a hosted AI account, and turns everyday developer questions into fast, actionable output.</p>
+<table>
+  <tr>
+    <td width="33%"><strong>✦ Think with you</strong><br>Explain concepts, suggest approaches, and turn errors into clear next steps.</td>
+    <td width="33%"><strong>◈ Inspect deeply</strong><br>Review code, optimize files, and scan projects for common security risks.</td>
+    <td width="33%"><strong>⌁ Fit your flow</strong><br>Use an interactive menu, shell completion, JSON output, or your own plugins.</td>
+  </tr>
+</table>
+<h2 id="start-in-60-seconds" class="tsd-anchor-link">Start in 60 seconds<a href="#start-in-60-seconds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><h3 id="1-install-dhruv" class="tsd-anchor-link">1. Install Dhruv<a href="#1-install-dhruv" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-3">-g</span><span class="hl-1"> </span><span class="hl-2">@rahul05ranjan/dhruv-cli</span>
+</code><button type="button">Copy</button></pre>
+
+<h3 id="2-start-a-local-model" class="tsd-anchor-link">2. Start a local model<a href="#2-start-a-local-model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Install <a href="https://ollama.com/">Ollama</a>, then run:</p>
+<pre><code class="bash"><span class="hl-0">ollama</span><span class="hl-1"> </span><span class="hl-2">serve</span><br/><span class="hl-0">ollama</span><span class="hl-1"> </span><span class="hl-2">pull</span><span class="hl-1"> </span><span class="hl-2">gemma3:270m</span>
+</code><button type="button">Copy</button></pre>
+
+<h3 id="3-configure-once-then-go" class="tsd-anchor-link">3. Configure once, then go<a href="#3-configure-once-then-go" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="bash"><span class="hl-0">dhruv</span><span class="hl-1"> </span><span class="hl-2">init</span><br/><span class="hl-0">dhruv</span><span class="hl-1"> </span><span class="hl-2">suggest</span><span class="hl-1"> </span><span class="hl-2">&quot;how should I structure this Node.js service?&quot;</span>
+</code><button type="button">Copy</button></pre>
+
+<p>Dhruv requires Node.js 18 or newer. The default model is <code>gemma3:270m</code>; choose any model available in your Ollama installation during setup.</p>
+<h2 id="a-command-surface-built-for-shipping" class="tsd-anchor-link">A command surface built for shipping<a href="#a-command-surface-built-for-shipping" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><table>
+<thead>
+<tr>
+<th>Command</th>
+<th>What it does</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><code>dhruv suggest &lt;query&gt;</code></td>
+<td>Generate practical suggestions for a development task</td>
+</tr>
+<tr>
+<td><code>dhruv explain &lt;query&gt;</code></td>
+<td>Explain a concept, command, or unfamiliar error</td>
+</tr>
+<tr>
+<td><code>dhruv fix &lt;query&gt;</code></td>
+<td>Analyze a coding issue and propose a fix</td>
+</tr>
+<tr>
+<td><code>dhruv review &lt;file-or-dir&gt;</code></td>
+<td>Review up to ten code files for quality and maintainability; add <code>--diff</code> for uncommitted changes</td>
+</tr>
+<tr>
+<td><code>dhruv optimize &lt;file&gt;</code></td>
+<td>Find actionable improvements for source or configuration files</td>
+</tr>
+<tr>
+<td><code>dhruv security-check [file-or-dir]</code></td>
+<td>Run a redacted local security analysis; add <code>--strict</code> for CI failure on high-confidence findings</td>
+</tr>
+<tr>
+<td><code>dhruv generate &lt;type&gt; &lt;target&gt;</code></td>
+<td>Preview generated tests by default; use <code>--apply</code>, <code>--output</code>, or <code>--overwrite</code> to write safely</td>
+</tr>
+<tr>
+<td><code>dhruv status</code></td>
+<td>Check Ollama connectivity and configured models</td>
+</tr>
+<tr>
+<td><code>dhruv health</code></td>
+<td>Show a concise health summary; use <code>--details</code> for diagnostics</td>
+</tr>
+<tr>
+<td><code>dhruv metrics</code></td>
+<td>Inspect local usage and performance metrics; use <code>--raw</code> or <code>--reset</code> explicitly</td>
+</tr>
+<tr>
+<td><code>dhruv project-type</code></td>
+<td>Detect the current project type</td>
+</tr>
+<tr>
+<td><code>dhruv menu</code></td>
+<td>Open the interactive command palette</td>
+</tr>
+<tr>
+<td><code>dhruv completion [shell]</code></td>
+<td>Generate Bash, Zsh, or Fish completion</td>
+</tr>
+</tbody>
+</table>
+<h3 id="common-workflows" class="tsd-anchor-link">Common workflows<a href="#common-workflows" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="bash"><span class="hl-4"># Understand and plan</span><br/><span class="hl-0">dhruv</span><span class="hl-1"> </span><span class="hl-2">explain</span><span class="hl-1"> </span><span class="hl-2">&quot;git rebase vs merge&quot;</span><br/><span class="hl-0">dhruv</span><span class="hl-1"> </span><span class="hl-2">suggest</span><span class="hl-1"> </span><span class="hl-2">&quot;deploy a React app to Vercel&quot;</span><br/><br/><span class="hl-4"># Improve an existing project</span><br/><span class="hl-0">dhruv</span><span class="hl-1"> </span><span class="hl-2">review</span><span class="hl-1"> </span><span class="hl-2">src/</span><br/><span class="hl-0">dhruv</span><span class="hl-1"> </span><span class="hl-2">review</span><span class="hl-1"> </span><span class="hl-3">--diff</span><span class="hl-1"> </span><span class="hl-2">.</span><br/><span class="hl-0">dhruv</span><span class="hl-1"> </span><span class="hl-2">optimize</span><span class="hl-1"> </span><span class="hl-2">package.json</span><br/><span class="hl-0">dhruv</span><span class="hl-1"> </span><span class="hl-2">security-check</span><span class="hl-1"> </span><span class="hl-2">src/</span><br/><span class="hl-0">dhruv</span><span class="hl-1"> </span><span class="hl-2">security-check</span><span class="hl-1"> </span><span class="hl-2">src/</span><span class="hl-1"> </span><span class="hl-3">--strict</span><br/><br/><span class="hl-4"># Generate and automate</span><br/><span class="hl-0">dhruv</span><span class="hl-1"> </span><span class="hl-2">generate</span><span class="hl-1"> </span><span class="hl-2">tests</span><span class="hl-1"> </span><span class="hl-2">src/utils/helpers.js</span><span class="hl-1">       </span><span class="hl-4"># preview only</span><br/><span class="hl-0">dhruv</span><span class="hl-1"> </span><span class="hl-2">generate</span><span class="hl-1"> </span><span class="hl-2">tests</span><span class="hl-1"> </span><span class="hl-2">src/utils/helpers.js</span><span class="hl-1"> </span><span class="hl-3">--apply</span><br/><span class="hl-0">dhruv</span><span class="hl-1"> </span><span class="hl-2">completion</span><span class="hl-1"> </span><span class="hl-2">zsh</span><span class="hl-1"> </span><span class="hl-5">&gt;</span><span class="hl-1"> </span><span class="hl-2">~/.zsh/completions/_dhruv</span>
+</code><button type="button">Copy</button></pre>
+
+<h2 id="configuration-that-stays-out-of-your-way" class="tsd-anchor-link">Configuration that stays out of your way<a href="#configuration-that-stays-out-of-your-way" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Run <code>dhruv init</code> to set the Ollama model, response format, verbosity, terminal theme, and whether settings are project-local or user-global. Local configuration is stored in <code>.dhruv-config.json</code>; global settings live under your user config directory.</p>
+<p>For one-off runs, use global flags:</p>
+<pre><code class="bash"><span class="hl-0">dhruv</span><span class="hl-1"> </span><span class="hl-2">suggest</span><span class="hl-1"> </span><span class="hl-2">&quot;summarize this migration&quot;</span><span class="hl-1"> </span><span class="hl-3">--model</span><span class="hl-1"> </span><span class="hl-2">llama3.2</span><span class="hl-1"> </span><span class="hl-3">--json</span><br/><span class="hl-0">dhruv</span><span class="hl-1"> </span><span class="hl-2">review</span><span class="hl-1"> </span><span class="hl-2">src/</span><span class="hl-1"> </span><span class="hl-3">--verbose</span><br/><span class="hl-0">dhruv</span><span class="hl-1"> </span><span class="hl-2">explain</span><span class="hl-1"> </span><span class="hl-2">&quot;what changed?&quot;</span><span class="hl-1"> </span><span class="hl-3">--timeout</span><span class="hl-1"> </span><span class="hl-3">60000</span>
+</code><button type="button">Copy</button></pre>
+
+<h2 id="extend-it-with-plugins" class="tsd-anchor-link">Extend it with plugins<a href="#extend-it-with-plugins" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Drop an ESM module into your project's <code>plugins/</code> directory. Dhruv loads <code>.js</code> plugins before parsing the command line, so you can add commands without changing the core CLI.</p>
+<pre><code class="js"><span class="hl-4">// plugins/hello.js</span><br/><span class="hl-5">export</span><span class="hl-1"> </span><span class="hl-5">default</span><span class="hl-1"> (</span><span class="hl-6">program</span><span class="hl-1">) </span><span class="hl-5">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">  program</span><br/><span class="hl-1">    .</span><span class="hl-0">command</span><span class="hl-1">(</span><span class="hl-2">&#39;hello-plugin&#39;</span><span class="hl-1">)</span><br/><span class="hl-1">    .</span><span class="hl-0">description</span><span class="hl-1">(</span><span class="hl-2">&#39;Say hello from a project plugin&#39;</span><span class="hl-1">)</span><br/><span class="hl-1">    .</span><span class="hl-0">action</span><span class="hl-1">(() </span><span class="hl-5">=&gt;</span><span class="hl-1"> console.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">&#39;Hello from Dhruv!&#39;</span><span class="hl-1">));</span><br/><span class="hl-1">};</span>
+</code><button type="button">Copy</button></pre>
+
+<p>Then run:</p>
+<pre><code class="bash"><span class="hl-0">dhruv</span><span class="hl-1"> </span><span class="hl-2">hello-plugin</span>
+</code><button type="button">Copy</button></pre>
+
+<h2 id="documentation--project-guides" class="tsd-anchor-link">Documentation &amp; project guides<a href="#documentation--project-guides" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><table>
+<thead>
+<tr>
+<th>Resource</th>
+<th>Link</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>Product site</td>
+<td><a href="https://rahul05ranjan.github.io/dhruv-cli/">rahul05ranjan.github.io/dhruv-cli</a></td>
+</tr>
+<tr>
+<td>API reference</td>
+<td><a href="https://rahul05ranjan.github.io/dhruv-cli/api/">Generated TypeDoc</a></td>
+</tr>
+<tr>
+<td>Contributing</td>
+<td><a href="media/CONTRIBUTING.md">CONTRIBUTING.md</a></td>
+</tr>
+<tr>
+<td>Security policy</td>
+<td><a href="media/SECURITY.md">SECURITY.md</a></td>
+</tr>
+<tr>
+<td>Publishing notes</td>
+<td><a href="media/publishing-fix.md">docs/publishing-fix.md</a></td>
+</tr>
+</tbody>
+</table>
+<h2 id="development" class="tsd-anchor-link">Development<a href="#development" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><br/><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">type-check</span><br/><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">test</span><br/><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">lint</span><br/><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">build</span>
+</code><button type="button">Copy</button></pre>
+
+<h2 id="license" class="tsd-anchor-link">License<a href="#license" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>MIT © <a href="https://github.com/rahul05ranjan">Rahul Ranjan</a></p>
+</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#why-dhruv"><span>Why <wbr/>Dhruv?</span></a><a href="#start-in-60-seconds"><span>Start in 60 seconds</span></a><ul><li><a href="#1-install-dhruv"><span>1. <wbr/>Install <wbr/>Dhruv</span></a></li><li><a href="#2-start-a-local-model"><span>2. <wbr/>Start a local model</span></a></li><li><a href="#3-configure-once-then-go"><span>3. <wbr/>Configure once, then go</span></a></li></ul><a href="#a-command-surface-built-for-shipping"><span>A command surface built for shipping</span></a><ul><li><a href="#common-workflows"><span>Common workflows</span></a></li></ul><a href="#configuration-that-stays-out-of-your-way"><span>Configuration that stays out of your way</span></a><a href="#extend-it-with-plugins"><span>Extend it with plugins</span></a><a href="#documentation--project-guides"><span>Documentation &amp; project guides</span></a><a href="#development"><span>Development</span></a><a href="#license"><span>License</span></a></div></details></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://rahul05ranjan.github.io/dhruv-cli/" class="tsd-nav-link">Home</a><a href="https://github.com/rahul05ranjan/dhruv-cli" class="tsd-nav-link">GitHub</a></nav><nav class="tsd-navigation"><a href="modules.html">Dhruv CLI API - v1.4.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/docs/api/media/CONTRIBUTING.md

@@ -0,0 +1,60 @@
+# Contributing to Dhruv CLI
+
+Thank you for your interest in contributing! 🎉
+
+## How to Contribute
+
+- **Bug Reports & Feature Requests:**
+  - Use [GitHub Issues](../../issues) to report bugs or request features.
+- **Pull Requests:**
+  - Fork the repo and create a new branch for your change.
+  - Write clear, concise commit messages.
+  - Ensure your code passes lint and build checks.
+  - Add or update tests as needed.
+  - Document your changes in the PR description.
+
+## Development Setup
+
+1. Clone the repo and install dependencies:
+   ```sh
+   git clone <repo-url>
+   cd devai-cli
+   npm install
+   ```
+2. Build and run locally:
+   ```sh
+   npm run build
+   npm start
+   ```
+3. For development:
+   ```sh
+   npm run dev
+   ```
+
+## Code Style
+- Use TypeScript and follow the existing code style.
+- Run `npx eslint .` before submitting a PR.
+
+## Testing
+- Add tests for new features or bug fixes.
+- Run tests with `npm test`.
+
+## Commit Message Guidelines
+- Use [Conventional Commits](https://www.conventionalcommits.org/) for commit messages.
+- **Allowed PR title types:**
+  - feat
+  - fix
+  - chore
+  - docs
+  - refactor
+  - style
+  - test
+  - ci
+- Example: `fix: update version to 1.1.3 and improve streaming response handling`
+- PR titles are checked automatically in CI. See `.github/workflows/contribution.yml` for details.
+
+## Code of Conduct
+- Be respectful and inclusive. See [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md).
+
+## License
+By contributing, you agree that your contributions will be licensed under the MIT License.

package/docs/api/media/SECURITY.md

@@ -0,0 +1,8 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability, please report it via GitHub Issues or contact the maintainers directly. We will respond as quickly as possible.
+
+- Do not disclose security issues publicly until they are resolved.
+- Provide as much detail as possible to help us resolve the issue quickly.