Quick Start Guide
Get up and running with ExplainThis in minutes. This guide will show you how to use our web interface and integrate ExplainThis into your development workflow.
Using the Web Interface
1. Choose Your Input Method
ExplainThis offers multiple ways to input your code:
- Direct Input: Paste your code directly into the editor
- File Upload: Upload a file from your computer
- GitHub Integration: Import code from a GitHub repository
2. Select Analysis Mode
Choose the type of explanation that best suits your needs:
- Standard: Comprehensive code explanation with key patterns and concepts
- Beginner: Simplified explanations with more context and examples
- Performance: Focus on efficiency, complexity, and optimization opportunities
- Security: Identify potential security issues and best practices
3. Get Your Explanation
Click "Explain This Code" and receive a detailed analysis of your code. The explanation includes:
- Line-by-line breakdown
- Key concepts and patterns
- Potential improvements
- Related documentation links
API Integration
For programmatic access, use our API with your preferred language:
JavaScript/TypeScript
import { ExplainThis } from '@explainthis/sdk';
// Initialize the client
const explainer = new ExplainThis({
apiKey: process.env.EXPLAINTHIS_API_KEY
});
// Get an explanation
const explanation = await explainer.explain(code, {
mode: 'standard',
language: 'javascript'
});Python
from explainthis import ExplainThis
# Initialize the client
explainer = ExplainThis(api_key="your-api-key")
# Get an explanation
explanation = explainer.explain(
code,
mode="standard",
language="python"
)