@ridit/lens 0.2.1 → 0.2.4

package/LENS.md

@@ -1,25 +1,68 @@
-# Lens Analysis
-> Generated: 2026-03-11T17:49:46.564Z
+# Lens - Codebase Intelligence Tool
 
-## Overview
-This project is a CLI tool called 'lens' that analyzes a repository and provides insights. It uses React, Ink, and various other libraries to create a text-based interface. The tool has several commands, including 'repo' for analyzing a remote repository, 'init' for initializing the tool, and 'review' for reviewing a local codebase. The project is designed for developers who want to quickly understand a repository's structure and content.
+Lens is a CLI tool that helps developers understand, navigate, and interact with codebases using AI-powered analysis.
 
-## Important Folders
-- src/components: contains various components, including FileReviewer, FileViewer, and ProviderPicker. Each component is used to display specific information about the repository.
-- src/commands: contains the implementation of the 'repo', 'init', and 'review' commands. Each command has its own file and exports a function that handles the command's logic.
-- src/utils: contains utility functions for tasks such as cloning a repository, reading files, and analyzing code. These functions are used throughout the project to perform specific tasks.
+## Core Features
 
-## Missing Configs
-- None detected
+- **Repository Analysis**: Analyze both local and remote repositories
+- **AI-Powered Insights**: Uses LLMs to understand code structure and content
+- **Interactive Chat**: Converse with your codebase using natural language
+- **Code Review**: Automated code reviews with specific suggestions
+- **Timeline Exploration**: Explore commit history and code evolution
+- **Task Automation**: Apply natural language changes to codebases
 
-## Security Issues
-- None detected
+## Supported AI Providers
 
-## Suggestions
-- In src/components/FileReviewer.tsx, consider adding a check to ensure that the 'files' prop is not empty before rendering the file list.
-- In src/commands/repo.tsx, consider adding error handling for cases where the repository URL is invalid or the repository cannot be cloned.
-- In src/utils/llm.ts, consider adding a timeout to the 'runPrompt' function to prevent it from running indefinitely if the model takes too long to respond.
+- Anthropic
+- Gemini (Google AI)
+- OpenAI
+- Ollama (local models)
+- Custom endpoints
 
-<!--lens-json
-{"overview":"This project is a CLI tool called 'lens' that analyzes a repository and provides insights. It uses React, Ink, and various other libraries to create a text-based interface. The tool has several commands, including 'repo' for analyzing a remote repository, 'init' for initializing the tool, and 'review' for reviewing a local codebase. The project is designed for developers who want to quickly understand a repository's structure and content.","importantFolders":["src/components: contains various components, including FileReviewer, FileViewer, and ProviderPicker. Each component is used to display specific information about the repository.","src/commands: contains the implementation of the 'repo', 'init', and 'review' commands. Each command has its own file and exports a function that handles the command's logic.","src/utils: contains utility functions for tasks such as cloning a repository, reading files, and analyzing code. These functions are used throughout the project to perform specific tasks."],"missingConfigs":[],"securityIssues":[],"suggestions":["In src/components/FileReviewer.tsx, consider adding a check to ensure that the 'files' prop is not empty before rendering the file list.","In src/commands/repo.tsx, consider adding error handling for cases where the repository URL is invalid or the repository cannot be cloned.","In src/utils/llm.ts, consider adding a timeout to the 'runPrompt' function to prevent it from running indefinitely if the model takes too long to respond."],"generatedAt":"2026-03-11T17:49:46.564Z"}
-lens-json-->
+## Technical Architecture
+
+- Built with React components rendered in terminal via Ink
+- TypeScript throughout for type safety
+- Bun as build tool and runtime
+- Commander.js for CLI structure
+- Modular command system with separate handlers
+
+## Commands
+
+- `lens repo <url>` - Analyze a remote repository
+- `lens review [path]` - Review a local codebase
+- `lens task <text>` - Apply natural language changes
+- `lens chat` - Interactive chat with codebase
+- `lens timeline` - Explore commit history
+- `lens provider` - Configure AI providers
+
+## Key Components
+
+- **Smart File Selection**: AI determines which files are most important
+- **Structured Analysis**: Provides overviews, folder insights, and suggestions
+- **Security Scanning**: Identifies potential security issues
+- **Multi-Model Support**: Flexible AI backend configuration
+
+## Installation
+
+```bash
+npm install -g @ridit/lens
+```
+
+## Usage
+
+```bash
+# Analyze a GitHub repository
+lens repo https://github.com/user/repo
+
+# Review local codebase
+lens review .
+
+# Chat with your code
+lens chat --path .
+
+# Make changes with natural language
+lens task "Add TypeScript types to this component" --path .
+```
+
+Lens helps developers quickly understand complex codebases through AI-assisted analysis and natural language interaction.