CodeFunc

Non-intrusive, zero-click architectural file overviews for VS Code.

💡 What is CodeFunc?

When exploring unfamiliar open-source codebases, reviewing team pull requests, or navigating complex enterprise architectures, developers spend cognitive energy reading dozens of lines just to understand:

• What is the primary responsibility of this file?
• What external services, libraries, or base images does it invoke?
• What ports, databases, files, or network endpoints are touched?

CodeFunc solves this directly at Line 0. It automatically places a clean, lightweight CodeLens glance header at the top of every file you open—requiring zero clicks, zero prompt typing, and zero side-panel distraction.

🔍 Role: Docker container build based on python:3.10-slim
📦 Uses: python:3.10-slim
💾 I/O: Exposes port 8000
[📖 Detailed Overview] [⚡ Refresh]

Clicking [📖 Detailed Overview] launches a dedicated glassmorphic side panel with deep architectural diagrams, data flow breakdown, and risk analysis.

✨ Key Highlights

⚡ 1. Universal File Intelligence (v0.1.6)

CodeFunc isn't just for programming languages—it now delivers rich structural overviews across your entire DevOps and infrastructure stack:

• 🐳 Dockerfiles: Automatically extracts base images, multi-stage build pipelines, exposed ports, and container entrypoint commands (CMD / ENTRYPOINT).
• 🐙 Docker Compose (docker-compose.yml): Identifies orchestrated services, backing container images, port forwarding bindings, and volume mounts.
• ⚙️ CI/CD Pipelines (GitHub Actions): Analyzes workflow triggers, jobs, and shared actions (actions/checkout, setup-node, etc.).
• 🐚 Shell Scripts (.sh, .bash, .zsh): Detects automation routines, sourced helper scripts, and CLI utilities (curl, docker, kubectl, rsync).
• 📦 Manifests & Configs (package.json, tsconfig.json): Summarizes package roles, build scripts, TypeScript compiler targets, and dependencies.
• 🗄️ SQL Schemas & Migrations (.sql): Identifies queried tables, DDL migrations (CREATE TABLE), and data mutation operations.
• 💻 All Major Languages: Full AST and heuristic parsing for Python, TypeScript, JavaScript, Go, Rust, Java, C, C++, and C#.

🛡️ 2. Intelligent Offline Fallback (Zero Config, 100% Free & Private)

• Works instantly out-of-the-box: No API key or account needed.
• Privacy-first: For non-technical users or enterprise environments with strict security policies, CodeFunc runs a sophisticated local static analysis engine that extracts key mechanisms, patterns, dependencies, and I/O completely on-device.
• Zero latency: Local summaries render in < 5 milliseconds with 0 network calls.

🧠 3. Multi-Provider AI Superpowers

Bring your favorite LLM provider for deep, human-like architectural summaries. CodeFunc automatically detects your key on paste:

🎨 4. Custom Analysis Personas

Tailor your code lens to your current objective via the codefunc.persona setting:

• General Developer: Focuses on architectural intent, high-level business logic, and component flow.
• Security Auditor: Highlights sensitive data handling, authentication/authorization layers, network attack surfaces, and untrusted inputs.
• Performance Expert: Spotlights computational complexity (e.g. 2D grid loops, nested iterations), memory allocations, and potential I/O bottlenecks.

⚡ 5. Performance by Design

• Cryptographic MD5 Caching: Unchanged files are hashed and served instantaneously from memory/workspace cache. Zero repeated API calls while editing.
• Smart Ignore Filter: Automatically ignores minified bundles (*.min.js, *.min.css), lockfiles (package-lock.json, pnpm-lock.yaml), binary assets (.png, .wasm, .pyc), and vendor folders (node_modules/, .git/).
• Responsive Stacking: If a summary exceeds your viewport, CodeFunc gracefully splits the content into stacked CodeLens lines so you never experience horizontal scroll overflow.

🔒 Security & Why We Don't Hardcode Shared API Keys

[!IMPORTANT] Design Philosophy: CodeFunc will never hardcode a shared public API key inside the extension client.

1. Vulnerability of Client Keys: Extensions distributed via the VS Code Marketplace are client-side JavaScript packages. Any hardcoded API key can be extracted by automated scrapers in seconds, leading to immediate revocation, billing abuse, or global rate limit lockouts for all users.
2. True Reliability: By pairing an intelligent zero-cost local offline parser with a Bring-Your-Own-Key (BYOK) model, you get 100% reliable functionality that never breaks because someone else burned through a shared token pool.
3. OS Keychain Encryption: When you provide an API key, it is encrypted in your operating system's native keychain using VS Code's SecretStorage API. It is never committed to Git, logged to disk, or sent to any intermediary server.

🚀 Installation & Quick Start

From VS Code Marketplace

1. Open VS Code.
2. Press Cmd+P (macOS) or Ctrl+P (Windows/Linux) and paste:

   ext install TanvirSdq.codefunc-vscode
   

3. Open any file (Python, TypeScript, Dockerfile, YAML, etc.)—CodeFunc is already working!

💡 Tip: Browsing code on GitHub? CodeFunc also has a Chrome Extension that injects the same glance header directly onto GitHub code pages. Check out the GitHub repository to download and load it locally!

⌨️ Command Palette Reference

Open the Command Palette (Cmd+Shift+P / Ctrl+Shift+P):

⚙️ Configuration Options

Customize CodeFunc via your VS Code settings.json:

{
  // Enable or disable CodeFunc CodeLens headers
  "codefunc.enabled": true,

  // AI Provider: "auto", "gemini", "groq", "openrouter", "anthropic"
  "codefunc.provider": "auto",

  // Optional custom model override (leave empty for recommended defaults)
  "codefunc.model": "",

  // Analysis persona: "General Developer", "Security Auditor", "Performance Expert"
  "codefunc.persona": "General Developer",

  // Show detected I/O and side effects in CodeLens
  "codefunc.showSideEffects": true,

  // Maximum character width before stacking CodeLens badges
  "codefunc.maxCodeLensLength": 70,

  // Skip minified files, lockfiles, and binaries to save tokens
  "codefunc.ignoreMinified": true,

  // Skip files larger than N lines (0 to disable)
  "codefunc.maxFileLines": 8000
}

📄 License

This project is licensed under the GNU Affero General Public License v3.0 (AGPLv3). See the LICENSE file for full details.

Copyright © 2026 Tanvir Siddique. All rights reserved.