CodeSense

AI-powered code documentation and analysis tool

CodeSense automatically generates comprehensive documentation for your codebase using AI. Scan projects, explain code, and create beautiful markdown documentation - all from your terminal.

✨ Features

• 🔍 Smart Code Analysis - Understands functions, classes, and dependencies
• 📚 Auto Documentation - Generates readable docs with AI
• 📝 README Generation - Creates project READMEs automatically
• 🎯 Dependency Graphs - Visualizes code relationships
• 🚀 Fast & Local - Runs on your machine with Ollama
• 💻 Multi-Language - Supports JavaScript, TypeScript (more coming!)

🚀 Quick Start

Prerequisites

# Install Ollama
brew install ollama

# Download AI model
ollama pull llama3.2:3b

# Start Ollama (in a separate terminal)
ollama serve

Installation

npm install -g codesense-cli

Usage

# Analyze a file
codesense explain auth.ts

# Scan entire project
codesense scan ./src

# Generate full documentation
codesense docs ./src

# Create README
codesense readme

📖 Commands

| Command | Description | | ---------------- | -------------------------------------- | | scan <path> | Analyze code files and show statistics | | explain <file> | Get AI explanation of a code file | | docs <path> | Generate comprehensive documentation | | readme [path] | Generate a README for your project |

🙏 Acknowledgments

• Built with Babel for parsing
• Powered by Ollama and Llama 3.2
• CLI built with Commander.js

Made with ❤️ by @Jush

📄 License

MIT License

Copyright (c) 2025 @Jashan66

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.