# code-reader-extension

**Repository Path**: jahentao/code-reader-extension

## Basic Information

- **Project Name**: code-reader-extension
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-10-29
- **Last Updated**: 2025-10-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Code Reader

AI-powered code reading assistant with text-to-speech functionality for VSCode.

## Features

- Select code in your editor and get AI-powered analysis
- Text-to-speech functionality to hear the code analysis
- Customizable TTS settings (rate, pitch, volume)
- Configuration for OpenAI API key and model selection

## Usage

1. Select code in your editor or place cursor in the line you want to analyze
2. Use the keyboard shortcut `Ctrl+Shift+R` (or `Cmd+Shift+R` on Mac) to analyze the code
3. Alternatively, run the command "Code Reader: Analyze Code with AI" from the command palette
4. The AI analysis will be spoken aloud and displayed in the status bar

## Configuration

The extension provides the following settings:

- `codeReader.apiKey`: Your OpenAI API key for code analysis
- `codeReader.model`: OpenAI model to use for code analysis (default: gpt-3.5-turbo)
- `codeReader.ttsEnabled`: Enable/disable text-to-speech (default: true)
- `codeReader.ttsRate`: Speech rate for text-to-speech (default: 1.0)
- `codeReader.ttsPitch`: Speech pitch for text-to-speech (default: 1.0)
- `codeReader.ttsVolume`: Speech volume for text-to-speech (default: 1.0)

## Requirements

- VSCode version 1.74.0 or higher
- OpenAI API key (optional, for full AI analysis)

## Known Issues

- When no API key is configured, the extension uses simple heuristics for code analysis
- TTS functionality only works in browsers that support the Web Speech API

## Release Notes

### 0.0.1

- Initial release
- Basic code analysis functionality
- Text-to-speech implementation
- Configuration options