legacyver 3.1.0 → 3.2.0

package/bin/legacyver.js

@@ -21,7 +21,7 @@ program
   .option('--out <dir>', 'Output directory (default: ./legacyver-docs)')
   .option('--format <fmt>', 'Output format: markdown | html | json (default: markdown)')
   .option('--model <model>', 'LLM model to use')
-  .option('--provider <provider>', 'LLM provider: openrouter | groq | gemini | kimi | ollama (default: openrouter)')
+  .option('--provider <provider>', 'LLM provider: groq | openrouter | gemini | kimi | ollama (default: groq)')
   .option('--concurrency <n>', 'Concurrent LLM requests 1-10 (default: 3)')
   .option('--dry-run', 'Run AST parsing only, no LLM calls')
   .option('--incremental', 'Only re-analyze changed files')

package/legacyver-docs/SUMMARY.md

@@ -1,3 +1,3 @@
-# Summary
-
-* [OrderController.php](OrderController.md)
+# Summary
+
+* [legacyver.js](legacyver.md)

package/legacyver-docs/index.md

@@ -1,15 +1,15 @@
-# Controllers — Documentation
-
-**Primary language:** php  
-**Total files:** 1  
-**Analyzed at:** 2026-02-22T03:45:37.186Z  
-
-## Files
-
-- [OrderController.php](OrderController.md)
-
-## Dependency Graph
-
-```mermaid
-graph TD
-```
+# bin — Documentation
+
+**Primary language:** javascript  
+**Total files:** 1  
+**Analyzed at:** 2026-03-21T11:31:12.941Z  
+
+## Files
+
+- [legacyver.js](legacyver.md)
+
+## Dependency Graph
+
+```mermaid
+graph TD
+```

package/legacyver-docs/legacyver.md

@@ -0,0 +1,49 @@
+## Overview
+`legacyver.js` is the entry point for the **legacyver** command‑line interface. It configures the `commander` program, loads the package version, registers all supported sub‑commands (analyze, init, providers, cache, login, logout, push) and parses the command‑line arguments.
+
+## Functions
+The file does not declare any JavaScript functions of its own. It only wires together imported command‑handler functions (e.g., `analyzeCmd`, `initCmd`, …) with the `commander` program.
+
+## Dependencies
+- **commander** – `program` is used to define the CLI, its options, and sub‑commands.  
+- **fs** – `readFileSync` reads `package.json` to obtain the current version.  
+- **path** – `join` builds the path to `package.json`.  
+- **../src/cli/commands/analyze** – handler for the `analyze` command (`analyzeCmd`).  
+- **../src/cli/commands/init** – handler for the `init` command (`initCmd`).  
+- **../src/cli/commands/providers** – handler for the `providers` command (`providersCmd`).  
+- **../src/cli/commands/cache** – handler for the `cache clear` sub‑command (`cacheCmd`).  
+- **../src/cli/commands/login** – handler for the `login` command (`loginCmd`).  
+- **../src/cli/commands/logout** – handler for the `logout` command (`logoutCmd`).  
+- **../src/cli/commands/push** – handler for the `push` command (`pushCmd`).  
+
+## Usage Example
+```bash
+# Show version and help
+legacyver -V
+legacyver --help
+
+# Analyze a codebase and write markdown docs to the default output folder
+legacyver analyze ./src \
+  --out ./legacyver-docs \
+  --format markdown \
+  --provider groq \
+  --concurrency 3
+
+# Run the interactive setup wizard
+legacyver init
+
+# List available LLM providers and models
+legacyver providers
+
+# Clear the incremental analysis cache
+legacyver cache clear
+
+# Log in to the cloud sync service
+legacyver login
+
+# Log out of the cloud sync service
+legacyver logout
+
+# Push already‑generated documentation to the cloud
+legacyver push ./legacyver-docs --out ./legacyver-docs
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "legacyver",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "AI-powered CLI tool to auto-generate technical documentation from legacy/undocumented codebases",
   "main": "src/index.js",
   "bin": {

package/src/cli/commands/init.js

@@ -24,8 +24,8 @@ module.exports = async function initCommand() {
     }
   }
 
-  const providerRaw = await ask(rl, `LLM provider [openrouter/groq/gemini/kimi/ollama] (default: openrouter): `);
-  const providerChoice = providerRaw.trim() || 'openrouter';
+  const providerRaw = await ask(rl, `LLM provider [groq/openrouter/gemini/kimi/ollama] (default: groq): `);
+  const providerChoice = providerRaw.trim() || 'groq';
   const isOllama = providerChoice === 'ollama';
   const isGroq = providerChoice === 'groq';
   const isGemini = providerChoice === 'gemini';
@@ -34,7 +34,7 @@ module.exports = async function initCommand() {
   const defaultModel = isOllama
     ? 'llama3.2'
     : isGroq
-      ? 'llama-3.3-70b-versatile'
+      ? 'openai/gpt-oss-120b'
       : isGemini
         ? 'gemini-2.0-flash'
         : isKimi
@@ -75,6 +75,35 @@ module.exports = async function initCommand() {
   writeFileSync(rcPath, JSON.stringify(config, null, 2), 'utf8');
   console.log(pc.green('\n✓ Created .legacyverrc'));
 
+  // If user left key blank, show how to set env var (cross-platform)
+  if (!isOllama && !apiKey.trim()) {
+    const isWin = process.platform === 'win32';
+    const envVarMap = {
+      groq:       { varName: 'GROQ_API_KEY',       url: 'https://console.groq.com/keys' },
+      openrouter: { varName: 'OPENROUTER_API_KEY', url: 'https://openrouter.ai/keys' },
+      gemini:     { varName: 'GEMINI_API_KEY',      url: 'https://aistudio.google.com/apikey' },
+      kimi:       { varName: 'MOONSHOT_API_KEY',    url: 'https://platform.moonshot.cn/console/api-keys' },
+    };
+    const envInfo = envVarMap[providerChoice] || envVarMap['openrouter'];
+
+    console.log('');
+    if (isGroq) {
+      console.log(pc.dim('i  No key entered — using built-in Groq key (openai/gpt-oss-120b).'));
+      console.log(pc.dim('   For higher rate limits, set your own key:'));
+    } else {
+      console.log(pc.yellow(`!  No API key saved. Set ${envInfo.varName} before running analyze.`));
+      console.log(pc.dim(`   Get a key: ${envInfo.url}`));
+    }
+    console.log('');
+    if (isWin) {
+      console.log(pc.dim(`   PowerShell:  $env:${envInfo.varName} = "your_key"`));
+      console.log(pc.dim(`   CMD:         set ${envInfo.varName}=your_key`));
+    } else {
+      console.log(pc.dim(`   Mac/Linux:   export ${envInfo.varName}=your_key`));
+    }
+    console.log(pc.dim('   Or re-run:   legacyver init  (enter the key when prompted)'));
+  }
+
   const exampleCmd = isOllama
     ? 'legacyver analyze --provider ollama'
     : isGroq
@@ -83,6 +112,7 @@ module.exports = async function initCommand() {
         ? 'legacyver analyze --provider gemini'
         : isKimi
           ? 'legacyver analyze --provider kimi'
-          : 'legacyver analyze'; // openrouter is the default, no flag needed
+          : 'legacyver analyze';
   console.log(pc.cyan(`\nRun \`${exampleCmd}\` to generate documentation.`));
 };
+

package/src/cli/commands/providers.js

@@ -3,14 +3,13 @@
 const pc = require('picocolors');
 const logger = require('../../utils/logger');
 
-const RECOMMENDED_MODELS = [
-  { id: 'meta-llama/llama-3.1-8b-instruct', context: '16k', inputCost: 0.02, outputCost: 0.05, free: false },
-  { id: 'anthropic/claude-haiku-3-5', context: '200k', inputCost: 0.80, outputCost: 4.00, free: false },
-  { id: 'anthropic/claude-sonnet-4-5', context: '200k', inputCost: 3.00, outputCost: 15.00, free: false },
-  { id: 'openai/gpt-4o-mini', context: '128k', inputCost: 0.15, outputCost: 0.60, free: false },
-  { id: 'openai/gpt-4o', context: '128k', inputCost: 5.00, outputCost: 15.00, free: false },
-  { id: 'google/gemini-flash-1.5', context: '1M', inputCost: 0.075, outputCost: 0.30, free: false },
-  { id: 'mistralai/mistral-7b-instruct:free', context: '32k', inputCost: 0, outputCost: 0, free: true },
+const GROQ_MODELS = [
+  { id: 'openai/gpt-oss-120b',                        context: '128k', isDefault: true },
+  { id: 'llama-3.3-70b-versatile',                    context: '128k', isDefault: false },
+  { id: 'llama-3.1-8b-instant',                       context: '128k', isDefault: false },
+  { id: 'meta-llama/llama-4-scout-17b-16e-instruct',  context: '128k', isDefault: false },
+  { id: 'meta-llama/llama-4-maverick-17b-128e-instruct', context: '128k', isDefault: false },
+  { id: 'gemma2-9b-it',                               context: '8k',   isDefault: false },
 ];
 
 module.exports = async function providersCommand() {
@@ -30,9 +29,10 @@ module.exports = async function providersCommand() {
 
   console.log(pc.bold('Legacyver — Supported LLM Providers\n'));
 
-  console.log(pc.bold('Groq') + '  (https://groq.com)');
-  console.log('  Fastest free LLM inference. 30 req/min, 14,400 req/day. Set GROQ_API_KEY env variable.');
-  console.log('  Status: ' + (process.env.GROQ_API_KEY ? pc.green('API key detected') : pc.yellow('No API key found')));
+  console.log(pc.bold('Groq') + pc.green(' [DEFAULT]') + '  (https://groq.com)');
+  console.log('  Fastest free LLM inference. 30 req/min, 14,400 req/day.');
+  console.log('  Default model: ' + pc.cyan('openai/gpt-oss-120b') + ' — override with your own GROQ_API_KEY for higher limits.');
+  console.log('  Status: ' + (process.env.GROQ_API_KEY ? pc.green('Own API key detected ✓') : pc.dim('Using built-in shared key (set GROQ_API_KEY for higher rate limits)')));
   console.log('  Get a free key at: https://console.groq.com/keys');
   console.log('');
   console.log(pc.bold('Google Gemini') + '  (https://ai.google.dev)');
@@ -45,7 +45,7 @@ module.exports = async function providersCommand() {
   console.log('  Status: ' + (process.env.MOONSHOT_API_KEY ? pc.green('API key detected') : pc.yellow('No API key found')));
   console.log('  Get a key at: https://platform.moonshot.cn/console/api-keys');
   console.log('');
-  console.log(pc.bold('OpenRouter') + pc.green(' [DEFAULT]') + '  (https://openrouter.ai)');
+  console.log(pc.bold('OpenRouter') + '  (https://openrouter.ai)');
   console.log('  Unified gateway to 200+ models (Claude, GPT-4o, Llama, etc). Set OPENROUTER_API_KEY env variable.');
   console.log('  Status: ' + (process.env.OPENROUTER_API_KEY ? pc.green('API key detected') : pc.yellow('No API key found')));
   console.log('  Get a key at: https://openrouter.ai/keys');
@@ -54,23 +54,20 @@ module.exports = async function providersCommand() {
   console.log('  Local offline LLM. No API key required. Run `ollama serve` first.');
   console.log('');
 
-  console.log(pc.bold('Recommended Models (via OpenRouter):'));
+  console.log(pc.bold('Available Groq Models (free, no key required):'));
   console.log('');
-  const header = `  ${'Model ID'.padEnd(48)} ${'Context'.padEnd(8)} ${'Input $/1M'.padEnd(12)} ${'Output $/1M'.padEnd(12)}`;
+  const header = `  ${'Model ID'.padEnd(52)} ${'Context'.padEnd(8)}`;
   console.log(pc.dim(header));
-  console.log(pc.dim('  ' + '-'.repeat(84)));
+  console.log(pc.dim('  ' + '-'.repeat(62)));
 
-  for (const m of RECOMMENDED_MODELS) {
-    const badge = m.free ? pc.green(' [FREE]') : '';
+  for (const m of GROQ_MODELS) {
+    const defaultBadge = m.isDefault ? pc.green(' [DEFAULT]') : '';
     const selected = m.id === config.model ? pc.cyan(' ◀ selected') : '';
-    const inputCostStr = m.free ? 'FREE' : `$${m.inputCost.toFixed(3)}`;
-    const outputCostStr = m.free ? 'FREE' : `$${m.outputCost.toFixed(3)}`;
-    console.log(
-      `  ${m.id.padEnd(48)} ${m.context.padEnd(8)} ${inputCostStr.padEnd(12)} ${outputCostStr.padEnd(12)}${badge}${selected}`
-    );
+    console.log(`  ${m.id.padEnd(52)} ${m.context.padEnd(8)}${defaultBadge}${selected}`);
   }
 
   console.log('');
-  console.log(pc.dim('Fetch live model list from OpenRouter: https://openrouter.ai/api/v1/models'));
+  console.log(pc.dim('Full Groq model list: https://console.groq.com/docs/models'));
+  console.log(pc.dim('For premium models (Claude, GPT-4o, etc.) use --provider openrouter'));
   console.log('');
 };

package/src/cli/ui.js

@@ -102,18 +102,28 @@ function printSummary(stats) {
     process.env.OPENROUTER_API_KEY
   );
   if (!usingOwnKey) {
+    const isWin = process.platform === 'win32';
     console.log(pc.dim('─────────────────────────────────────────────────'));
-    console.log(pc.cyan('  Bring your own API key for better results:'));
+    console.log(pc.cyan('  Running on built-in Groq key') + pc.dim(' (openai/gpt-oss-120b)'));
     console.log('');
-    console.log(`  ${pc.bold('Free tiers')}  — more quota, same zero cost`);
-    console.log(pc.dim('  Groq:      https://console.groq.com/keys'));
-    console.log(pc.dim('  Gemini:    https://aistudio.google.com/apikey'));
+    console.log('  To get higher rate limits, set your own free Groq key:');
+    console.log(pc.dim('  Get key: https://console.groq.com/keys'));
+    if (isWin) {
+      console.log(pc.dim('  PowerShell: $env:GROQ_API_KEY = "your_key"'));
+      console.log(pc.dim('  CMD:        set GROQ_API_KEY=your_key'));
+    } else {
+      console.log(pc.dim('  Mac/Linux:  export GROQ_API_KEY=your_key'));
+    }
+    console.log(pc.dim('  Or run:  legacyver init'));
     console.log('');
-    console.log(`  ${pc.bold('Premium')}     — smarter models (Claude, GPT-4o, etc.)`);
-    console.log(pc.dim('  OpenRouter: https://openrouter.ai/keys'));
-    console.log(pc.dim('  Access 200+ models, pay only for what you use.'));
-    console.log('');
-    console.log(pc.dim('  Run `legacyver init` to set your key, then:'));
+    console.log(`  ${pc.bold('Want premium models?')} (Claude, GPT-4o, etc.)`);
+    console.log(pc.dim('  Get key: https://openrouter.ai/keys'));
+    if (isWin) {
+      console.log(pc.dim('  PowerShell: $env:OPENROUTER_API_KEY = "your_key"'));
+      console.log(pc.dim('  CMD:        set OPENROUTER_API_KEY=your_key'));
+    } else {
+      console.log(pc.dim('  Mac/Linux:  export OPENROUTER_API_KEY=your_key'));
+    }
     console.log(pc.dim('  legacyver analyze --provider openrouter --model anthropic/claude-haiku-3-5'));
     console.log(pc.dim('─────────────────────────────────────────────────'));
     console.log('');

package/src/llm/providers/groq.js

@@ -3,10 +3,12 @@
 const { NoApiKeyError } = require('../../utils/errors');
 
 const GROQ_BASE = 'https://api.groq.com/openai/v1';
-const DEFAULT_MODEL = 'llama-3.3-70b-versatile';
+const DEFAULT_MODEL = 'openai/gpt-oss-120b';
 // Built-in shared key — lets users run legacyver out of the box without setup.
 // Users can override with their own GROQ_API_KEY env var for higher rate limits.
-const BUILT_IN_KEY = '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';
+// Groq does NOT auto-revoke keys found in public packages (unlike OpenRouter).
+const BUILT_IN_KEY = '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';
+
 class GroqProvider {
   constructor(config) {
     this.apiKey = process.env.GROQ_API_KEY || config.groqApiKey || BUILT_IN_KEY;

package/src/llm/validator.js

@@ -47,7 +47,7 @@ function validateFragment(fragment, fileFacts) {
     'Dependencies', 'Dependency', 'Async', 'Static', 'Public', 'Private', 'Protected',
     'Boolean', 'String', 'Number', 'Object', 'Array', 'Void', 'Null', 'Undefined',
     'True', 'False', 'Error', 'Promise', 'Request', 'Response',
-    'Node', 'JavaScript', 'TypeScript', 'PHP', 'Python',
+    'Node', 'JavaScript', 'TypeScript', 'PHP', 'Python', 'PostgreSQL',
     'Laravel', 'Express', 'Route', 'Controller', 'Model', 'Service', 'Repository',
     'Middleware', 'Provider', 'Summary', 'None', 'Name', 'Description', 'Value', 'Type',
     'Map', 'Set', 'Date',

package/src/utils/config.js

@@ -59,7 +59,7 @@ function loadConfig(cliFlags = {}) {
   }
 
   const defaults = {
-    provider: 'openrouter',
+    provider: 'groq',
     model: undefined,
     format: 'markdown',
     out: './legacyver-docs',

package/legacyver-docs/OrderController.md

@@ -1,80 +0,0 @@
-## Overview
-This is the `OrderController` class, responsible for handling CRUD (Create, Read, Update, Delete) operations on orders. It provides a RESTful API interface to interact with the order data.
-
-## Functions
-
-### index
-#### Description
-Returns a paginated list of orders.
-#### Parameters
-| Parameter | Type | Required |
-| --- | --- | --- |
-| `paginate` | int | - |
-| `response` | object | - |
-| `json` | function | - |
-
-#### Return Value
-A `JsonResponse` containing the paginated list of orders.
-
-### store
-#### Description
-Creates a new order and returns its details.
-#### Parameters
-| Parameter | Type | Required |
-| --- | --- | --- |
-| `$request:StoreOrderRequest` | object | Yes |
-
-#### Return Value
-A `JsonResponse` with the created order data and HTTP status code 201.
-
-### show
-#### Description
-Returns a single order by its ID.
-#### Parameters
-| Parameter | Type | Required |
-| --- | --- | --- |
-| `$id:int` | int | Yes |
-
-#### Return Value
-A `JsonResponse` containing the order details.
-
-### update
-#### Description
-Updates an existing order.
-#### Parameters
-| Parameter | Type | Required |
-| --- | --- | --- |
-| `$request:UpdateOrderRequest` | object | Yes |
-| `$id:int` | int | Yes |
-
-#### Return Value
-A `JsonResponse` with the updated order data.
-
-### destroy
-#### Description
-Deletes an existing order.
-#### Parameters
-| Parameter | Type | Required |
-| --- | --- | --- |
-| `$id:int` | int | Yes |
-
-#### Return Value
-A `JsonResponse` with HTTP status code 204.
-
-## Dependencies
-
-* `App\Models\Order`
-* `App\Models\User`
-* `App\Http\Requests\StoreOrderRequest`
-* `App\Http\Requests\UpdateOrderRequest`
-* `App\Services\OrderService`
-* `Illuminate\Http\JsonResponse`
-
-## Usage Example
-```php
-$orderController = new OrderController();
-$orders = $orderController->index(); // returns paginated list of orders
-
-$order = $orderController->store(new StoreOrderRequest(['name' => 'New Order'])); // creates and returns order details
-```
-Note: The usage example is just a demonstration and should be replaced with actual usage scenarios.

package/legacyver-docs/bin/legacyver.md

@@ -1,107 +0,0 @@
-## Overview
-The `legacyver` CLI tool is an AI-powered tool for auto-generating technical documentation from legacy/undocumented codebases. It provides various commands for analysis, initialization, provider management, caching, login, logout, and pushing documentation to the cloud.
-
-## Functions
-### `analyzeCmd`
-#### Description
-Analyze a directory and generate documentation.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| `target` | string | The directory to analyze. |
-| `--out <dir>` | string | Output directory (default: `./legacyver-docs`). |
-| `--format <fmt>` | string | Output format: `markdown`, `html`, or `json` (default: `markdown`). |
-| `--model <model>` | string | LLM model to use. |
-| `--provider <provider>` | string | LLM provider: `groq` or `ollama` (default: `groq`). |
-| `--concurrency <n>` | number | Concurrent LLM requests (1-10) (default: `3`). |
-| `--dry-run` | boolean | Run AST parsing only, no LLM calls. |
-| `--incremental` | boolean | Only re-analyze changed files. |
-| `--no-confirm` | boolean | Skip cost confirmation prompt. |
-| `--json-summary` | boolean | Output machine-readable JSON summary. |
-| `--max-file-size <kb>` | number | Skip files larger than this size in KB (default: `500`). |
-
-#### Return Value
-None
-
-### `initCmd`
-#### Description
-Interactive setup wizard — saves API key and creates `.legacyverrc`.
-
-#### Parameters
-None
-
-#### Return Value
-None
-
-### `providersCmd`
-#### Description
-List supported LLM providers and available models.
-
-#### Parameters
-None
-
-#### Return Value
-None
-
-### `cacheCmd`
-#### Description
-Manage the incremental analysis cache.
-
-#### Parameters
-None
-
-#### Return Value
-None
-
-### `loginCmd`
-#### Description
-Log in to sync generated docs to the cloud.
-
-#### Parameters
-None
-
-#### Return Value
-None
-
-### `logoutCmd`
-#### Description
-Log out and stop syncing docs to the cloud.
-
-#### Parameters
-None
-
-#### Return Value
-None
-
-### `pushCmd`
-#### Description
-Manually push generated docs to the cloud database.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| `target` | string | The directory to push from. |
-| `--out <dir>` | string | Docs output directory to read from (default: `./legacyver-docs`). |
-
-#### Return Value
-None
-
-## Dependencies
-* `commander`
-* `fs`
-* `path`
-* `dotenv`
-* `../src/cli/commands/analyze`
-* `../src/cli/commands/init`
-* `../src/cli/commands/providers`
-* `../src/cli/commands/cache`
-* `../src/cli/commands/login`
-* `../src/cli/commands/logout`
-* `../src/cli/commands/push`
-
-## Usage Example
-```bash
-legacyver analyze my-project --out docs --format markdown
-```
-This command analyzes the `my-project` directory, generates documentation in Markdown format, and outputs it to the `docs` directory.

package/legacyver-docs/src/api/auth.md

@@ -1,47 +0,0 @@
-## Overview
-This module provides two functions for managing CLI session tokens: `validateToken` and `revokeToken`. These functions interact with a PostgreSQL database to validate and revoke tokens.
-
-## Functions
-
-### validateToken
-Validates a CLI session token against app.user_sessions.
-
-* **Description**: Returns user info if valid, null if expired/revoked/not found.
-* **Params**:
-	+ `token`: raw token from ~/.legacyver/session.json (string)
-	+ `opts`: optional overrides for testing (object)
-		- `pool`: pg Pool instance (object)
-* **Return Value**: Promise<{userId: string, username: string, email: string} | null>
-
-### revokeToken
-Revoke a CLI session token (logout).
-
-* **Description**: Revoke a CLI session token.
-* **Params**:
-	+ `token`: raw token (string)
-	+ `opts`: optional overrides for testing (object)
-		- `pool`: pg Pool instance (object)
-* **Return Value**: None
-
-## Dependencies
-* `crypto`: crypto module
-* `pg`: pg module
-* `../db/config`: dbConfig module
-
-## Usage Example
-```javascript
-const { validateToken, revokeToken } = require('./auth');
-
-// Validate a token
-const token = 'your_token_here';
-const opts = { pool: your_pool_instance };
-validateToken(token, opts).then((userInfo) => {
-  console.log(userInfo);
-});
-
-// Revoke a token
-const token = 'your_token_here';
-revokeToken(token, opts).then(() => {
-  console.log('Token revoked');
-});
-```

package/legacyver-docs/src/cache/hash.md

@@ -1,24 +0,0 @@
-## Overview
-This module provides a function to compute the SHA-256 hash of a file.
-
-## Functions
-### computeHash
-Computes the SHA-256 hash of a file.
-
-| Parameter | Type | Description |
-| --- | --- | --- |
-| filePath | string | Path to the file to compute the hash for |
-
-| Return Value | Type | Description |
-| --- | --- | --- |
-| string | The SHA-256 hash as a hex string prefixed with 'sha256:' |
-
-## Dependencies
-* crypto: createHash
-* fs: readFileSync
-
-## Usage Example
-```javascript
-const { computeHash } = require('./hash');
-console.log(computeHash('path/to/file.txt'));
-```