https://github.com/laiso/askrepo
Source code reading with LLM.
https://github.com/laiso/askrepo
codeanalyzer gemini llm
Last synced: 5 months ago
JSON representation
Source code reading with LLM.
- Host: GitHub
- URL: https://github.com/laiso/askrepo
- Owner: laiso
- License: mit
- Created: 2024-11-03T10:21:53.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-30T12:34:32.000Z (about 1 year ago)
- Last Synced: 2025-10-25T10:53:10.482Z (8 months ago)
- Topics: codeanalyzer, gemini, llm
- Language: TypeScript
- Homepage: https://crates.io/crates/askrepo
- Size: 91.8 KB
- Stars: 221
- Watchers: 3
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- StarryDivineSky - laiso/askrepo - -prompt "What is the purpose of this code?"../your-repo/src` 命令进行使用。 (A01_文本生成_文本对话 / 大语言对话模型及数据)
README
# askrepo - Source code reading with LLM
This program reads the content of Git-managed text files in a specified
directory, sends it to the Google Gemini API, and provides answers to questions
based on the specified prompt. It supports streaming responses for real-time
feedback.
## Usage
```bash
❯ askrepo --help
Usage: askrepo [options] [base_path]
Arguments:
base_path Directory containing source code files
Options:
-p, --prompt Question to ask about the source code [default: "Explain the code in the files provided"]
-m, --model Google AI model to use [default: "gemini-1.5-flash"]
-a, --api-key Google API key
-u, --base-url API endpoint URL [default: "https://generativelanguage.googleapis.com/v1beta/models/"]
--stream Enable/disable streaming mode [default: true]
-v, --verbose Enable verbose output
-h, --help Show help
```
## Installation
### Using Deno
#### Run directly without installation
```bash
# Run directly using Deno
export GOOGLE_API_KEY="YOUR_API_KEY"
deno run -A jsr:@laiso/askrepo --prompt "What is this code doing?" ../your-repo/src
```
#### Install globally
```bash
# Install globally using Deno
deno install -A --global jsr:@laiso/askrepo
# Make sure $HOME/.deno/bin is in your PATH
export PATH="$HOME/.deno/bin:$PATH"
# Then run the command
export GOOGLE_API_KEY="YOUR_API_KEY"
askrepo --prompt "What is the purpose of this code?" ../your-repo/src
```
### Gemini API Key
A Gemini API key is required to run this program. You can get it from:
https://aistudio.google.com/app/apikey
## Examples
### Using Google Gemini API (default)
```bash
export GOOGLE_API_KEY="YOUR_API_KEY"
askrepo --prompt "What is the purpose of this code?" ../your-repo/src
# Using short options
askrepo -p "What is the purpose of this code?" -m "gemini-2.0-flash" ../your-repo/src
```
### Using OpenAI API
```bash
export OPENAI_API_KEY="YOUR_OPENAI_API_KEY"
askrepo --prompt "What is the purpose of this code?" \
--model "o3-mini" \
--base-url "https://api.openai.com/v1/chat/completions" \
../your-repo/src
# Using short options
askrepo -p "What is the purpose of this code?" \
-m "o3-mini" \
-u "https://api.openai.com/v1/chat/completions" \
../your-repo/src
```
## Development
```bash
# Run the project in development mode
deno run -A mod.ts --prompt "Find bugs in this code" ./src
```
## Run Tests
```bash
# Run tests
deno test
```
## Implementation Details
### Git-managed File Tracking
The tool uses the `.gitignore` parser to determine which files to include:
- Scans directories recursively while respecting `.gitignore` rules at each
level
- Skips binary files, hidden files, and `node_modules` directories
- Caches `.gitignore` rules to optimize performance
### Binary File Detection
Files are identified as binary through two complementary methods:
1. **Extension-based detection**: Checks if the file extension matches known
binary formats (jpg, png, etc.)
2. **Content-based detection**:
- Looks for null bytes in the first 1024 bytes
- Identifies binary file signatures (magic numbers) for common formats like
JPEG, PNG, and GIF
### File Content Processing
- Reads text content from all non-binary tracked files
- Double-escapes content to ensure proper JSON formatting
- Combines file content into a tab-separated format with filename references
### LLM Integration
- Constructs a structured prompt that includes:
- File paths and their contents
- The user's question
- Instructions for the model to reference specific files in its response
- Supports both Google's Generative AI models (Gemini) and OpenAI-compatible
APIs
### Streaming Response Handling
- Uses Deno's native fetch API with streaming support
- Processes chunk-based responses in real-time
- Parses SSE (Server-Sent Events) data format from the API
- Handles both streamed and non-streamed responses
### Command Line Interface
- Built on Deno's standard library for parsing arguments
- Provides sensible defaults for all options
- Auto-detects API keys from environment variables
- Supports both standard and shorthand options
- Returns helpful error messages for invalid inputs
## Features
- Streaming support for real-time AI responses
- Flexible API endpoint configuration
- Improved response parsing for different formats
- Support for both streaming and non-streaming modes
- Default to the latest Gemini model (gemini-2.0-flash), but can be configured
to use other models
- Support for OpenAI Compatible API