Introduction to Code-y

Code-y is the most comprehensive, 100% local-first command-line tool and documentation platform for React, TypeScript, and JavaScript projects. It combines advanced static code analysis, AI-powered insights, and an interactive web interface to give you unprecedented visibility into your codebase.

🔒 Privacy-First Philosophy

Your code stays on your machine. Code-y is designed with privacy as the foundation:

• All AI processing happens locally via Ollama or your own OpenAI API key.
• Vector embeddings are generated and stored locally.
• No data transmission to external services (unless you explicitly configure OpenAI).
• Complete offline capability with local AI models.
• Full control over your documentation and analysis data.

🚀 Core Capabilities

Code-y provides a suite of powerful tools to help you understand, document, and improve your code:

• Advanced Code Analysis: Deep AST parsing to identify components, functions, and their relationships, including circular dependencies and prop drilling.
• Local AI Intelligence: Use local models via Ollama or your own OpenAI key to generate documentation, explain code, and perform semantic searches with a FAISS vector database.
• Interactive Documentation UI: A rich web interface with component explorers, code visualizations, and an AI-powered chat assistant that is fully aware of your codebase context.
• Powerful CLI: A flexible command-line interface to generate, serve, and build your documentation site.