Getting Started

Introduction

Welcome to AI Developer Assistant documentation.

Welcome to AI Developer Assistant, a modular, open-source AI-powered tool designed to automate, accelerate, and improve your software development lifecycle.

What is AI Developer Assistant?

AI Developer Assistant is a command-line tool that helps developers review, understand, document, refactor, test, and secure code using AI models while maintaining privacy, extensibility, and open access. It supports both local (offline) and remote LLMs, providing flexibility for different privacy and performance needs.

Key Features

This tool includes a comprehensive range of features designed to improve your development workflow:

Code Review & Analysis

Identify logical errors, style issues, and missing documentation with AI-powered analysis

Security Scanning

Detect common vulnerabilities and security issues across multiple programming languages

Test Generation

Generate test case templates with automatic framework detection

Command Reference

Complete command reference and usage examples for all AI Developer Assistant features

Core Capabilities

This tool provides a comprehensive suite of development assistance features:

  • AI-Powered Code Review: Analyze code for logical errors, style issues, and best practices
  • Multi-Language Support: Automatic language detection for Dart, TypeScript, JavaScript, Python, Java, C#, Go, Rust, and more
  • Framework Auto-Selection: Automatically chooses appropriate testing frameworks for each language
  • Privacy-First Design: Supports both local (Ollama) and cloud (OpenAI, Gemini) LLMs
  • Security Scanning: Detect vulnerabilities and security issues with severity-based filtering
  • Test Automation: Generate comprehensive test cases with setup and teardown code
  • Documentation Generation: Create API docs, README files, and code documentation
  • Developer Mentorship: Get educational feedback on code quality and best practices
  • Clean Architecture: Built with Hexagonal Architecture principles for extensibility
  • Beautiful Output: Colorized, structured output with language-specific syntax highlighting