@ridit/lens 0.2.4 → 0.2.5

package/LENS.md

@@ -1,68 +1,32 @@
-# Lens - Codebase Intelligence Tool
-
-Lens is a CLI tool that helps developers understand, navigate, and interact with codebases using AI-powered analysis.
-
-## Core Features
-
-- **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
-
-## Supported AI Providers
-
-- Anthropic
-- Gemini (Google AI)
-- OpenAI
-- Ollama (local models)
-- Custom endpoints
-
-## 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.
+# Lens Analysis
+> Generated: 2026-03-21T11:15:38.543Z
+
+## Overview
+Lens is a CLI tool built with React components rendered in the terminal via Ink, designed to help developers understand, navigate, and interact with codebases using AI-powered analysis. The tool provides repository analysis, AI-powered insights, interactive chat, code review, timeline exploration, and task automation capabilities. Key components include ChatRunner for interactive conversations, RepoAnalysis for repository examination, and various command handlers like ReviewCommand and TaskCommand. The project uses Bun as a build tool and runtime, with Commander.js for CLI structure and TypeScript throughout for type safety.
+
+## Important Folders
+- src/components: Contains core UI components like ChatRunner (handles interactive chat), RepoAnalysis (analyzes repositories), DiffViewer (shows code differences), and ProviderPicker (selects AI providers). These components use Ink for terminal rendering and provide the main user interface.
+- src/commands: Implements all CLI commands including repo (analyze remote repositories), review (local codebase analysis), task (apply natural language changes), chat (interactive conversation), timeline (commit history exploration), and commit (smart commit message generation).
+- src/utils: Contains utility functions for AI integration (ai.ts), chat processing (chat.ts), configuration management (config.ts), file operations (files.ts), git operations (git.ts), memory management (memory.ts), and thinking animations (thinking.tsx).
+- src/tools: Provides various tool implementations including files (file operations), shell (command execution), web (URL fetching), pdf (PDF generation), and git (version control operations). These tools are used throughout the chat functionality.
+
+## Missing Configs
+- ESLint configuration: The project uses TypeScript but lacks an ESLint config file (.eslintrc.js or eslint.config.js) for code quality enforcement
+- Testing setup: No test framework configuration (Jest/Vitest) or test files found, which is important for a developer tool of this complexity
+- GitHub Actions CI/CD: Missing workflow files for automated testing and deployment, which would help maintain quality for a CLI tool
+
+## Security Issues
+- In src/utils/chat.ts: The parseResponse function uses regex-based XML parsing which could be vulnerable to injection attacks if malformed responses are processed
+- In src/utils/repo.ts: The cloneRepo function uses exec() with user-provided URLs without proper sanitization, potentially allowing command injection
+- In multiple files: API keys and sensitive information are handled without encryption in config files stored in ~/.lens directory
+
+## Suggestions
+- In src/utils/chat.ts: Replace regex-based XML parsing with a proper XML parser library to prevent injection vulnerabilities and improve reliability
+- In src/utils/repo.ts: Use execFile with proper argument sanitization instead of exec() for git operations to prevent command injection attacks
+- In src/utils/config.ts: Implement encryption for storing API keys in the config file rather than plaintext storage
+- In src/components/chat/ChatRunner.tsx: Add pagination or virtualization for long chat histories to improve performance with many messages
+- In package.json: Add linting and testing scripts to establish better code quality practices for the project
+
+<!--lens-json
+{"overview":"Lens is a CLI tool built with React components rendered in the terminal via Ink, designed to help developers understand, navigate, and interact with codebases using AI-powered analysis. The tool provides repository analysis, AI-powered insights, interactive chat, code review, timeline exploration, and task automation capabilities. Key components include ChatRunner for interactive conversations, RepoAnalysis for repository examination, and various command handlers like ReviewCommand and TaskCommand. The project uses Bun as a build tool and runtime, with Commander.js for CLI structure and TypeScript throughout for type safety.","importantFolders":["src/components: Contains core UI components like ChatRunner (handles interactive chat), RepoAnalysis (analyzes repositories), DiffViewer (shows code differences), and ProviderPicker (selects AI providers). These components use Ink for terminal rendering and provide the main user interface.","src/commands: Implements all CLI commands including repo (analyze remote repositories), review (local codebase analysis), task (apply natural language changes), chat (interactive conversation), timeline (commit history exploration), and commit (smart commit message generation).","src/utils: Contains utility functions for AI integration (ai.ts), chat processing (chat.ts), configuration management (config.ts), file operations (files.ts), git operations (git.ts), memory management (memory.ts), and thinking animations (thinking.tsx).","src/tools: Provides various tool implementations including files (file operations), shell (command execution), web (URL fetching), pdf (PDF generation), and git (version control operations). These tools are used throughout the chat functionality."],"missingConfigs":["ESLint configuration: The project uses TypeScript but lacks an ESLint config file (.eslintrc.js or eslint.config.js) for code quality enforcement","Testing setup: No test framework configuration (Jest/Vitest) or test files found, which is important for a developer tool of this complexity","GitHub Actions CI/CD: Missing workflow files for automated testing and deployment, which would help maintain quality for a CLI tool"],"securityIssues":["In src/utils/chat.ts: The parseResponse function uses regex-based XML parsing which could be vulnerable to injection attacks if malformed responses are processed","In src/utils/repo.ts: The cloneRepo function uses exec() with user-provided URLs without proper sanitization, potentially allowing command injection","In multiple files: API keys and sensitive information are handled without encryption in config files stored in ~/.lens directory"],"suggestions":["In src/utils/chat.ts: Replace regex-based XML parsing with a proper XML parser library to prevent injection vulnerabilities and improve reliability","In src/utils/repo.ts: Use execFile with proper argument sanitization instead of exec() for git operations to prevent command injection attacks","In src/utils/config.ts: Implement encryption for storing API keys in the config file rather than plaintext storage","In src/components/chat/ChatRunner.tsx: Add pagination or virtualization for long chat histories to improve performance with many messages","In package.json: Add linting and testing scripts to establish better code quality practices for the project"],"generatedAt":"2026-03-21T11:15:38.543Z"}
+lens-json-->

package/README.md

@@ -0,0 +1,91 @@
+# Lens
+
+Lens is an AI-powered CLI tool that lets you explore, understand, and modify any codebase through natural language. Built with React and Ink for a rich terminal UI, Lens connects to multiple LLM providers and gives the AI direct access to your filesystem, shell, and the web.
+
+## Features
+
+- **Chat with your codebase** — ask questions, request changes, scaffold new files
+- **Multi-provider support** — Anthropic, OpenAI, Gemini, Ollama, or any OpenAI-compatible API
+- **Tool system** — AI can read/write files, run shell commands, fetch URLs, search the web, clone repos, generate PDFs, and more
+- **Plugin registry** — extend Lens with custom tools via `@ridit/lens-sdk`
+- **Diff preview** — proposed code changes are shown as a diff before applying
+- **Auto-approve mode** — `/auto` skips confirmation for safe read/search tools
+- **Force-all mode** — `/auto --force-all` approves everything including shell and writes
+- **Persistent memory** — Lens remembers project-specific context across sessions
+- **Chat history** — save, load, rename, and delete chat sessions per repo
+- **Smart commits** — generate conventional commit messages from staged changes
+- **Timeline** — browse and explore commit history
+- **Repo analysis** — deep codebase review from a remote URL or local path
+
+## Installation
+
+```bash
+# using bun
+bun add @ridit/lens -g
+
+# using npm
+npm install -g @ridit/lens
+```
+
+## CLI Commands
+
+```
+lens chat                        chat with your codebase
+lens chat -p /path/to/repo       chat in a specific repo
+
+lens review                      AI review of the current directory
+lens review /path/to/repo        AI review of a specific repo
+
+lens repo <url>                  analyze a remote GitHub repository
+
+lens task <text>                 apply a natural language change to the codebase
+lens task <text> -p /path        apply change to a specific repo
+
+lens commit                      generate a smart commit message from staged changes
+lens commit [files...]           stage specific files and generate a commit message
+lens commit --auto               stage all changes and commit without confirmation
+lens commit --confirm            show preview before committing when using --auto
+lens commit --preview            show the generated message without committing
+lens commit --push               push to remote after committing
+
+lens timeline                    explore commit history
+lens timeline -p /path           explore history of a specific repo
+
+lens provider                    configure AI providers
+```
+
+## Chat Commands
+
+Once inside a `lens chat` session, use slash commands:
+
+```
+/timeline              browse commit history
+/review                AI review of the current codebase
+/auto                  toggle auto-approve for safe tools (read, search, fetch)
+/auto --force-all      auto-approve ALL tools including shell and writes ⚠️
+/chat list             list saved chat sessions for this repo
+/chat load <name>      load a saved chat session
+/chat rename <name>    rename the current session
+/chat delete <name>    delete a saved session
+/memory list           list stored memories for this repo
+/memory add <text>     add a memory
+/memory delete <id>    delete a memory by ID
+/memory clear          clear all memories for this repo
+/clear history         wipe session memory for this repo
+```
+
+## Supported Providers
+
+- **Anthropic** — Claude models
+- **OpenAI** — GPT models
+- **Gemini** — Google Gemini models
+- **Ollama** — local models
+- **Custom** — any OpenAI-compatible API endpoint
+
+## Extending Lens
+
+Custom tools can be built and registered using [`@ridit/lens-sdk`](https://www.npmjs.com/package/@ridit/lens-sdk).
+
+## License
+
+MIT